lichtblick-suite/lichtblick

Lichtblick

Lichtblick is an integrated visualization and diagnosis tool for robotics, available in your browser or as a desktop app on Linux, Windows, and macOS.

Dependencies:

• Node.js v16.10+
• Git LFS

---

🚀 Getting started

Clone the repository:

$ git clone https://github.com/bmw-software-engineering/lichtblick.git

Pull large files with Git LFS:

$ git lfs pull

Enable corepack:

$ corepack enable

Install packages from package.json:

$ yarn install

• If you still get errors about corepack after running corepack enable, try uninstalling and reinstalling Node.js. Ensure that Yarn is not separately installed from another source, but is installed via corepack.

Launch the development environment:

# To launch the desktop app (run both scripts concurrently):
$ yarn desktop:serve        # start webpack
$ yarn desktop:start        # launch electron

# To launch the web app:
$ yarn run web:serve        # it will be avaiable in http://localhost:8080

🛠️ Building Lichtblick

Build the application for production using these commands:

# To build the desktop apps:
$ yarn run desktop:build:prod   # compile necessary files

- yarn run package:win         # Package for windows
- yarn run package:darwin      # Package for macOS
- yarn run package:linux       # Package for linux

# To build the web app:
$ yarn run web:build:prod

# To build and run the web app using docker:
$ docker build . -t lichtblick
$ docker run -p 8080:8080 lichtblick

# It is possible to clean up build files using the following command:
$ yarn run clean

• The desktop builds are located in the dist directory, and the web builds are found in the web/.webpack directory.

📝 License (Open Source)

Lichtblick follows an open core licensing model. Most functionality is available in this repository, and can be reproduced or modified per the terms of the Mozilla Public License v2.0.

🤝 Contributing

Contributions are welcome! Lichtblick is primarily built in TypeScript and ReactJS. All potential contributors must agree to the Contributor License Agreement outlined in CONTRIBUTING.md.

⭐ Credits

Lichtblick originally began as a fork of FoxGlove Studio, an open source project developed by Foxglove.

lichtblick's Issues

Question about installed extensions in docker container

Hello! Thank you for this standalone fork of FoxGlove. I have one question about extensions. When I used FoxGlove, desktop extensions were installed in ~/.foxglove-studio/extensions folder, so I could programmatically install them with some bash commands without GUI. Now I want to do something similar with FoxBox, but in Docker container, as It supports this feature.

I successfully installed my extension via drag-and-drop. And, I suppose, this can be done if I place and unpack content of my .foxe file in some folder inside docker container or mount folder with installed extensions from host. However, I could not find a folder in container, where my extension was saved.

Can you give me some hints, where to look for these files?

P.S. It is not a bug. If I choose "quesion" while making an issue, it redirects me to official foxglove discussion

Cannot connect through Foxglove bridge

Dear Lichtblick team,

Lichtblick worked perfectly for me when connecting to my ROS2 system through the Foxglove bridge. Recently, this stopped working out of the blue. I have the feeling this happened when I updated my system, which upgraded ros-humble-foxglove-bridge to version 0.8.0. Have you experienced this issue?

• Version: 1.3.6
• Platform: Pop_OS 22.04
• Data source: ROS2 native through Foxglove bridge