Installation

On every release, all rovercom definitions are transpiled to Go, C, Python and TypeScript files.

Go

You can install rovercom as a Go package for your Go module as follows:

# Install latest version
go get github.com/VU-ASE/rovercom/v2
# Install a specific version
go get github.com/VU-ASE/rovercom/v2@v2.0.0
# LEGACY: Install a v1 version
go get github.com/VU-ASE/rovercom@v1.5.1

Additionally you will need to install the general proto package:

go get google.golang.org/protobuf

Python

You can find the transpiled Python files in our repository here.

Additionally, you will need to install the betterproto package:

pip install betterproto

C

You can find the transpiled C header and source files in our repository here. Import the header files and make sure to include the C source files when compiling.

TypeScript

We recommend using bun to install rovercom from our repository directly. You can do so by running:

# Install lateset version
bun add "github:VU-ASE/rovercom"
# Install a specific version
bun add "github:VU-ASE/rovercom#v2.0.0"

Then, add the following postinstall script to your package.json file:

...
  "scripts": {
    "postinstall": "cp -r node_modules/rovercom/packages/typescript/. node_modules/rovercom-temp && rm -rf node_modules/rovercom && mv node_modules/rovercom-temp node_modules/rovercom",
...

After installation, the package is available as rovercom. Which you can import like so:

// Import control types from rovercom
import { ConnectionState, ControlError } from 'rovercom/gen/control/control';

Using NPM (legacy)

You can install rovercom as an NPM package for your TypeScript project as follows:

# Install latest version
npm install https://gitpkg.vercel.app/VU-ASE/rovercom/packages/typescript
# Install a specific version
npm install https://gitpkg.vercel.app/VU-ASE/rovercom/packages/typescript?v1.5.1

After installation, the package will be added as ase-rovercom.

Other

You will need to manually compile the given definitions using the protoc compiler and its plugins for your language of choice. We recommend taking a look at our compilation targets and Devcontainer setup to understand which tools you need.