Skip to content

Commit

Permalink
Update links (#1136)
Browse files Browse the repository at this point in the history
### Public-Facing Changes

Updates outdated links in documentation and code samples
  • Loading branch information
jtbandes authored Mar 12, 2024
1 parent cec54d9 commit 6addfd5
Show file tree
Hide file tree
Showing 12 changed files with 22 additions and 21 deletions.
2 changes: 1 addition & 1 deletion cpp/examples/protobuf/writer.cpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Example code for writing Protobuf messages to an MCAP file. This executable
// writes a sequence of foxglove.PointCloud messages to an MCAP which should
// show an expanding sphere when viewed in Foxglove Studio.
// show an expanding sphere when viewed in Foxglove.
#define MCAP_IMPLEMENTATION
#include "mcap/writer.hpp"

Expand Down
3 changes: 2 additions & 1 deletion python/examples/jsonschema/pointcloud_csv_to_mcap.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
""" Example script for converting pointcloud CSV data to an MCAP viewable in Foxglove Studio.
""" Example script for converting pointcloud CSV data to an MCAP viewable in Foxglove.
This script uses the public CSV dataset "Sydney Urban Objects Dataset",
released by the Australian Centre for Field Robotics at the University of Sydney, NSW, Australia.
Expand All @@ -10,6 +10,7 @@
pip install mcap
python3 pointcloud_csv_to_mcap.py sydney-urban-objects-dataset/objects/4wd.0.2299.csv -o out.mcap
"""

import argparse
import base64
import csv
Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ A stream of messages which have the same type, or schema. Often corresponds to a
A description of the structure and contents of messages on a channel, e.g. a [Protobuf Schema](https://protobuf.dev/programming-guides/proto3/) or [JSON Schema](https://json-schema.org/).

:::info
The [foxglove/schemas](https://github.com/foxglove/schemas) repo provides pre-defined schemas for [Foxglove Studio](https://foxglove.dev/studio) visualizations.
The [foxglove/schemas](https://github.com/foxglove/schemas) repo provides [pre-defined schemas](https://docs.foxglove.dev/docs/visualization/message-schemas/introduction) for Foxglove visualizations.
:::
6 changes: 3 additions & 3 deletions website/docs/guides/cpp/protobuf.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To read Protobuf messages from an MCAP file using C++, we have two options:

- **Dynamic** – Dynamically read fields using the schema definitions in the MCAP file

Preferred for inspecting and debugging message content. For example, when building a [visualization tool](https://studio.foxglove.dev), we want to provide a full view of all fields in a message as it was originally recorded. We can use Protobuf's [`DynamicMessage`](https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.dynamic_message) class to enumerate and inspect message fields in this way.
Preferred for inspecting and debugging message content. For example, when building a [visualization tool](https://app.foxglove.dev), we want to provide a full view of all fields in a message as it was originally recorded. We can use Protobuf's [`DynamicMessage`](https://developers.google.com/protocol-buffers/docs/reference/cpp/google.protobuf.dynamic_message) class to enumerate and inspect message fields in this way.

### Statically generated class definitions

Expand Down Expand Up @@ -282,9 +282,9 @@ writer.close();

### Inspect MCAP file

Now, we can inspect our output MCAP file's messages. Use the _Data source_ dialog in [Foxglove Studio](https://studio.foxglove.dev) to “Open local file”.
Now, we can inspect our output MCAP file's messages. Use the “Open local file” button in [Foxglove](https://app.foxglove.dev).

Add a few relevant panels ([Plot](https://foxglove.dev/docs/studio/panels/plot), [Image](https://foxglove.dev/docs/studio/panels/image), [Raw Messages](https://foxglove.dev/docs/studio/panels/raw-messages), [3D](https://foxglove.dev/docs/studio/panels/3d)) to visualize the robot's performance.
Add a few relevant panels ([Plot](https://docs.foxglove.dev/docs/visualization/panels/plot), [Image](https://docs.foxglove.dev/docs/visualization/panels/image), [Raw Messages](https://docs.foxglove.dev/docs/visualization/panels/raw-messages), [3D](https://docs.foxglove.dev/docs/visualization/panels/3d)) to visualize the robot's performance.

## Important links

Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/getting-started/flatbuffers.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,4 @@ See also the [official FlatBuffers docs](https://google.github.io/flatbuffers/)

## Visualize MCAP

[Foxglove Studio](https://foxglove.dev/studio) To play back MCAP files containing FlatBuffers-encoded data in Foxglove Studio, be sure the MCAP Channel's `message_encoding` field is set to `flatbuffer`. Note that in order for Foxglove Studio to read FlatBuffer data from channels in MCAP files, the [MCAP Schema record](https://mcap.dev/specification/index.html#schema-op0x03) should contain the binary flatbuffer schema (`.bfbs`) content in its `data` field. They can be compiled using `flatc -b --schema [...args]`, using the `.fbs` files as input. For more info, see the [MCAP specification for FlatBuffers encoding](https://mcap.dev/specification/appendix.html#flatbuffer_1).
To play back MCAP files containing FlatBuffers-encoded data in [Foxglove](https://app.foxglove.dev/), be sure the MCAP Channel's `message_encoding` field is set to `flatbuffer`. Note that in order for Foxglove to read FlatBuffer data from channels in MCAP files, the [MCAP Schema record](https://mcap.dev/specification/index.html#schema-op0x03) should contain the binary flatbuffer schema (`.bfbs`) content in its `data` field. They can be compiled using `flatc -b --schema [...args]`, using the `.fbs` files as input. For more info, see the [MCAP specification for FlatBuffers encoding](https://mcap.dev/specification/appendix.html#flatbuffer_1).
12 changes: 6 additions & 6 deletions website/docs/guides/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ We provide MCAP readers and writers in the following languages:

Once you have MCAP data to work with, you may want to [**use the mcap CLI to inspect and interact with your MCAP files**](https://github.com/foxglove/mcap/tree/main/go/cli/mcap#examples).

You can also start visualizing your MCAP data with third-party tools like [Foxglove Studio](https://foxglove.dev/studio). To start leveraging all the visualizations Studio has to offer, you must write messages that adhere to a pre-defined set of Foxglove schemas.
You can also start visualizing your MCAP data with third-party tools like [Foxglove](https://app.foxglove.dev/). To start leveraging all the visualizations Foxglove has to offer, you must write messages that adhere to a pre-defined set of Foxglove schemas.

The [@foxglove/schemas](https://github.com/foxglove/schemas) repo provides pre-defined schemas in the following data serialization formats:

Expand All @@ -39,17 +39,17 @@ The [@foxglove/schemas](https://github.com/foxglove/schemas) repo provides pre-d
- [FlatBuffers](https://github.com/foxglove/schemas/tree/main/schemas/flatbuffer)
- [TypeScript](https://github.com/foxglove/schemas/tree/main/schemas/typescript)

Next, download Foxglove Studio as a [desktop app](https://foxglove.dev/download), or navigate to [studio.foxglove.dev](https://studio.foxglove.dev) in your web browser.
Next, download Foxglove as a [desktop app](https://foxglove.dev/download), or navigate to [app.foxglove.dev](https://app.foxglove.dev) in your web browser.

**For local MCAP files**, simply drag and drop the file into the Studio app to start playing back your data.
**For local MCAP files**, simply drag and drop the file into the Foxglove app to start playing back your data.

**For remote MCAP files**, select "Open file from URL" when you first load the Studio app, and specify the URL to your remote MCAP file. Open the connection to start playing back your data.
**For remote MCAP files**, select "Open file from URL" when you first load the Foxglove app, and specify the URL to your remote MCAP file. Open the connection to start playing back your data.

Add and configure different [panels](https://foxglove.dev/docs/studio/panels/introduction) to your [layout](https://foxglove.dev/docs/studio/layouts) to visualize different aspects of your data.
Add and configure different [panels](https://docs.foxglove.dev/docs/visualization/panels/introduction/) to your [layout](https://docs.foxglove.dev/docs/visualization/layouts/) to visualize different aspects of your data.

## Store MCAP

[Sign up for a Foxglove account ](https://console.foxglove.dev) to access the data management features of [Foxglove Data Platform](https://foxglove.dev/data-platform) .
[Sign up for a Foxglove account](https://app.foxglove.dev/signup) to access the data management features of Foxglove.

Instead of having to pass around hard drives every time you want to share data, you can start importing your MCAP data into a central repository for all your teammates to access and collaborate on.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/getting-started/json.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ For an exhaustive list of ways to interact with your MCAP data, check out the [`

## Visualize MCAP

[Foxglove Studio](https://foxglove.dev/studio) supports playing back local and remote MCAP files containing JSON data.
[Foxglove](https://foxglove.dev/) supports playing back local and remote MCAP files containing JSON data.
2 changes: 1 addition & 1 deletion website/docs/guides/getting-started/protobuf.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ For an exhaustive list of ways to interact with your MCAP data, check out the [`

## Visualize MCAP

[Foxglove Studio](https://foxglove.dev/studio) supports playing back local and remote MCAP files containing Protobuf data.
[Foxglove](https://foxglove.dev/) supports playing back local and remote MCAP files containing Protobuf data.
2 changes: 1 addition & 1 deletion website/docs/guides/getting-started/ros-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,4 @@ For an exhaustive list of ways to interact with your MCAP data, check out the [m

## Visualize MCAP

[Foxglove Studio](https://foxglove.dev/studio) supports playing back local and remote ROS 1 bag files, as well as local and remote MCAP files containing ROS 1 data.
[Foxglove](https://foxglove.dev/) supports playing back local and remote ROS 1 bag files, as well as local and remote MCAP files containing ROS 1 data.
2 changes: 1 addition & 1 deletion website/docs/guides/getting-started/ros-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,6 @@ For an exhaustive list of ways to interact with your MCAP data, check out the [m

## Visualize MCAP

[Foxglove Studio](https://foxglove.dev/studio) supports playing back local and remote ROS 2 db3 files, as well as local and remote MCAP files containing ROS 2 data.
[Foxglove](https://foxglove.dev/) supports playing back local and remote ROS 2 db3 files, as well as local and remote MCAP files containing ROS 2 data.

With that said, we recommend MCAP files over ROS 2 db3 files, as the latter are not completely self-contained.
6 changes: 3 additions & 3 deletions website/docs/guides/python/json.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This prints out the timestamp, intensity, and coordinates for each point in the

### Encode data as a `foxglove.PointCloud`

Let's encode this CSV data as a [`foxglove.PointCloud` schema](https://foxglove.dev/docs/studio/messages/point-cloud), so we can later visualize this data in [Foxglove Studio](https://foxglove.dev/studio):
Let's encode this CSV data as a [`foxglove.PointCloud` schema](https://docs.foxglove.dev/docs/visualization/message-schemas/point-cloud), so we can later visualize this data in [Foxglove](https://foxglove.dev/):

| field | type | description |
| -------------- | -------------------- | ---------------------------------------------------------------- |
Expand Down Expand Up @@ -108,7 +108,7 @@ with open(args.output, "wb") as f:

### Register channel

Let's create a channel of messages to contain our point cloud. The schema's name and content tell Foxglove Studio that it can parse and display this message as a point cloud.
Let's create a channel of messages to contain our point cloud. The schema's name and content tell Foxglove that it can parse and display this message as a point cloud.

```python
with open(Path(__file__).parent / "PointCloud.json", "rb") as f:
Expand Down Expand Up @@ -176,7 +176,7 @@ $ mcap doctor output.mcap

### Visualize data

For a more visual representation of this data, let's use Foxglove Studio. Open either the [desktop](https://foxglove.dev/download) or [web app](https://studio.foxglove.dev), and add a [Raw Messages Panel](https://foxglove.dev/docs/studio/panels/raw-messages) and [3D Panel](https://foxglove.dev/docs/studio/panels/3d) to your layout.
For a more visual representation of this data, let's use Foxglove. Open either the [desktop](https://foxglove.dev/download) or [web app](https://app.foxglove.dev/view), and add a [Raw Messages Panel](https://docs.foxglove.dev/docs/visualization/panels/raw-messages) and [3D Panel](https://docs.foxglove.dev/docs/visualization/panels/3d) to your layout.

Then, simply drag and drop your output MCAP file into the app window to start playing the data. Make sure to enable the `pointcloud` topic in the 3D (Beta) panel to display the point cloud in 3D space. You can also inspect the raw data for the `pointcloud` topic in your Raw Messages panel: ![pointcloud](./json-hero.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ export function McapRecordingDemo(): JSX.Element {
</button>
Try inspecting the file with the{" "}
<Link to="/guides/cli">MCAP CLI</Link>, or open it in{" "}
<Link to="https://studio.foxglove.dev/">Foxglove Studio</Link>.
<Link to="https://app.foxglove.dev/">Foxglove</Link>.
</div>
)}

Expand Down

0 comments on commit 6addfd5

Please sign in to comment.