GO3D Interconnect

API & read-only instrument bridge kit · Beta

Download the complete kit

Setup & scope

# GO3D Interconnect — API & Instrument Bridge Kit v1 beta

This kit connects exported observations to the Virtual Island's read-only preview. It does not include proprietary vendor SDKs, instrument drivers, instrument motion control, calibration or certification. Keep original engineering data and verified transforms in your authoritative project repository.

## Included

- Dependency-free Node.js bridge with authenticated JSON endpoints and CORS allowlist.
- Explicit simulation mode; it never masquerades as a hardware connection.
- CSV observation sender, Rhino selected-point export sample, Revit element-center export sample.
- Observation JSON Schema and official SDK catalog.
- `server.test.mjs` exercises auth, validation and simulated status.

## Run a local simulation

Node.js 20 or later is required.

```sh
GO3D_TOKEN=choose-a-long-random-secret GO3D_DEMO=1 node server.mjs
```

The default listener is `127.0.0.1:8765`. A browser on another device cannot reach another computer's loopback address. An HTTPS app may block an HTTP bridge. For mobile/browser use, deploy the bridge on an HTTPS endpoint with a trusted certificate. Configure `GO3D_TLS_KEY` and `GO3D_TLS_CERT`; non-loopback binding without TLS is rejected. Keep credentials outside source control.

In Virtual Island → Labs → Instrument connections, enter the bridge URL and the matching token. Tokens are held only in the current tab and sent in Authorization headers. Never put tokens in URLs.

## Connect real observations

Run the bridge with `GO3D_DEMO` unset. A licensed vendor SDK/adapter or an approved exported CSV sends POST `/v1/observations` using the token. Before an adapter submits data, health reports `not connected` and observation reads return 503. Connecting a bridge alone is not proof of a connected or calibrated instrument.

```json
{"instrument":"Named instrument + serial / SDK version","units":"m","crs":"VERIFIED-SITE-GRID","observations":[{"id":"P1","x":0,"y":0,"z":0},{"id":"P2","x":1,"y":0,"z":0},{"id":"P3","x":0,"y":1,"z":0}]}
```

GET `/health` returns mode and adapter status. GET `/v1/observations` returns the latest submitted points and server reception time. All routes require `Authorization: Bearer <token>`. No endpoint commands movement or changes an instrument.

## SDK and interchange routes

See `vendor-catalog.json` for official Revit, Autodesk Reality Solutions/ReCap, Rhino.Compute, SOLIDWORKS, Hexagon SpatialAnalyzer, Leica/GeoCOM partner program, Leica LGSx, CloudCompare, Open3D, PDAL, Blender, Potree, CesiumJS, Apple ARKit and Matterport sources. Download SDKs from those sources under their own licenses. Catalog entries do not mean those engines are bundled or installed.

The island directly previews XYZ/CSV, PLY, uncompressed LAS, STL, OBJ geometry, and self-contained GLB. It does not directly parse RCP/RCS, RVT, IFC, E57/LAZ or proprietary CAD formats. Translate these in the licensed source program or an appropriate external pipeline first. Check units, CRS, axis convention and registration before comparing datasets.

The Revit example exports bounding-box centers only and requires a matching modern .NET Revit SDK. It is supplied as uncompiled source. The Rhino sample requires Rhino and is supplied as unexecuted integration source. Neither sample has been tested against a customer's installed CAD software in this release.

## Field acceptance

Confirm instrument model/firmware, driver and SDK versions; known control observations; units and datum; timestamp/latency; disconnected behavior; calibration status and residuals. Mark a connection verified only after a real instrument test. The beta's designed samples are not forensic findings, surveyed boundaries or manufacturing approval.