Skip to main content

Greenroom Platform SDK

The Platform SDK is how third-party systems integrate with Greenroom's GAMA and Lookout maritime autonomy products. It is a gRPC + Protobuf API: a single, versioned, language-agnostic contract that gives you a real-time view of the vessel and its surroundings, and lets you command it.

The SDK is the recommended integration path for all clients.

Pre-release

The v1 schema is not yet officially released and may change in backward-incompatible ways until the first stable release. Pin to a specific schema commit and expect to update — see Versioning.

What you can do​

The API is organised into domains that together describe and control the vessel:

  • Vessel — the vessel's own position, orientation, and motion.
  • Perception — the fused operational picture: tracked objects and object alerts.
  • Control — mode, arming, control authority, and actuator state.
  • Mission — load, run, and observe autonomous mission plans.
  • Diagnostics — vessel health.

How it works​

Protobuf schema  ──▶  Buf Schema Registry  ──▶  generated gRPC SDK  ──▶  your application
                      (browse + install)        (Python / C++ / TS)

The Protobuf schema is published to the Buf Schema Registry (BSR). You install a generated gRPC client for your language straight from the BSR — there is no code generation step on your side for Python or TypeScript, and a single command for C++. Every method is strongly typed, and real-time data is delivered over gRPC streams.

Next steps​

  1. Install the SDK for your language.
  2. Authenticate against a Platform endpoint.
  3. Follow the Quickstart to make your first call.

New to the platform? Start with Building with the Platform SDK. Hit a snag? See Troubleshooting.