Install the SDK

The gRPC SDK is generated from the published schema and served by the Buf Schema Registry (BSR). Python, C++, and TypeScript are the primary supported languages, covered below.

Why gRPC everywhere?

The Platform API is gRPC-only — a deliberate fit for the constrained, intermittent links typical of maritime deployments. There is no separate REST surface; every client below is a gRPC client.

Other languages

The BSR also generates clients for Go, Java/Kotlin, Rust, Swift, and C#. The SDKs page on the BSR generates a copy-paste install snippet for any language and shows the current package names and versions — the commands below show the shape for the primary three.

Python
C++
TypeScript

Install the generated gRPC client (service stubs plus messages) from the BSR's Python registry:

pip install \
  greenroom-robotics-platform-sdk-grpc-python \
  greenroom-robotics-platform-sdk-protocolbuffers-python \
  --extra-index-url https://buf.build/gen/python

The gRPC runtime (grpcio) is pulled in as a dependency.

C++ is generated from the published schema with the buf CLI. Create a buf.gen.yaml:

buf.gen.yaml
version: v2
plugins:
  - remote: buf.build/protocolbuffers/cpp
    out: gen
  - remote: buf.build/grpc/cpp
    out: gen

Then generate the sources directly from the BSR module:

buf generate buf.build/greenroom-robotics/platform-sdk

Compile the generated gen/** sources into your project and link against gRPC and Protobuf.

Point npm at the BSR's npm registry by adding to .npmrc:

.npmrc
@buf:registry=https://buf.build/gen/npm/v1

Install the generated client (protobuf-es types and service definitions) and the Connect runtime, which speaks gRPC:

npm install \
  @buf/greenroom-robotics_platform-sdk.bufbuild_es \
  @connectrpc/connect @connectrpc/connect-node

Continue to Authenticate.

Next​

Next