ASAM OSI Converter extension for Lichtblick

What is this extension about?

A converter extension which visualizes data following the standard of the ASAM Open Simulation Interface (ASAM OSI) using the native 3D panel of Lichtblick.

Getting started

Get Lichtblick from github.

Get extension file from releases.

Install the extension in Lichtblick by dragging the .foxe file into the Lichtblick window.

Open a file/stream which is following the ASAM OSI standard.

Coding guidelines

The code should follow the coding guidelines of Lichtblick. This includes the usage of typescript, prettier, eslint and the lichtblick-suite sdk.

Develop

Extension development uses the yarn package manager to install development dependencies and run build scripts.

To install extension dependencies, run yarn from the root of the extension package.

yarn install

To build and install the extension into your local Foxglove Studio desktop app, run:

yarn run local-install

Open the Lichtblick desktop (or ctrl-R to refresh if it is already open). Your extension is installed and available within the app.

Package

Extensions are packaged into .foxe files. These files contain the metadata (package.json) and the build code for the extension.

Before packaging, make sure to set name, publisher, version, and description fields in package.json. When ready to distribute the extension, run:

yarn run package

This command will package the extension into a .foxe file in the local directory.