|
| 1 | +# Nvblox Foxglove |
| 2 | + |
| 3 | +Nvblox Foxglove provides tools to visualize nvblox ROS messages in |
| 4 | +[Foxglove Studio](https://github.com/foxglove/studio). |
| 5 | + |
| 6 | + |
| 7 | +## Installation |
| 8 | + |
| 9 | +This extension uses the `npm` package manager to install dependencies and run |
| 10 | +build scripts. All `npm` commands have to be run from the `nvblox_foxglove` folder. |
| 11 | + |
| 12 | +> This extension is known to work with node versions `v10.2.3` and `v20.10.0`. Other |
| 13 | +(particularly older) versions fail during the installation steps. To update node |
| 14 | +run, we recommend using `nvm`, to upgrade node. |
| 15 | +> ``` |
| 16 | +> curl https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash |
| 17 | +> nvm install 20.10.0 |
| 18 | +> nvm use 20.10.0 |
| 19 | +> ``` |
| 20 | +
|
| 21 | +To install extension dependencies, run: |
| 22 | +
|
| 23 | +```npm install ``` |
| 24 | +
|
| 25 | +To build and install the extension into your local Foxglove Studio desktop app, run: |
| 26 | +
|
| 27 | +```npm run local-install ``` |
| 28 | +
|
| 29 | +To test the extensions open the `Foxglove Studio` desktop (or `ctrl-R` to refresh if it is already |
| 30 | +open). Your extension is installed and available within the app. You can open `Foxglove Studio` from |
| 31 | +a terminal with the command `foxglove-studio`. |
| 32 | +
|
| 33 | +
|
| 34 | +## Development |
| 35 | +
|
| 36 | +If you want to view debugging messages printed by `console.log(...)` from the extension make sure to |
| 37 | +run `export ELECTRON_ENABLE_LOGGING=1` in the terminal where you open `Foxglove Studio`. |
| 38 | +
|
| 39 | +
|
| 40 | +## Packaging |
| 41 | +
|
| 42 | +Extensions are packaged into `.foxe` files. These files contain the metadata (package.json) and the |
| 43 | +build code for the extension. |
| 44 | +
|
| 45 | +The following command will package the extension into a `.foxe` file in the local directory. |
| 46 | +
|
| 47 | +```npm run package ``` |
| 48 | +
|
| 49 | +
|
| 50 | +## Publishing |
| 51 | +
|
| 52 | +You can publish the extension for the public marketplace or privately for your organization. |
| 53 | +
|
| 54 | +See documentation here: https://foxglove.dev/docs/studio/extensions/publish#packaging-your-extension |
0 commit comments