Skip to main content

SDK v0.8.0

Foxglove SDK

This release provides additional functionality for WebSocket services and examples for usage.

Python

Adds Message.get_schema() and various channel getters

Rust

Adds a foxglove::Encode derive macro to automatically serialize structs and enums.

Log timestamps may now be specified as u64, Timestamp, SystemTime, or DateTime.

C++

The C++ library now supports logging Foxglove-defined schemas.

It also provides more functionality for live visualization, including services, assets, websocket parameters, and parameter subscriptions.

Changed

Python

  • Add simple example of writing RawAudio messages to an MCAP
  • Add Message.get_schema() and various channel getters

Rust

  • Add shutdown handle for WebSocket server
  • Add foxglove::Encode derive macro
  • Add features for derive, lz4, schemars, zstd
  • Accept u64, Timestamp, SystemTime, and DateTime as log timestamps

C++

  • Catch callback exceptions
  • Provide an interface to set the level of SDK stderr logging
  • Add support for services, assets, websocket parameters, and parameter subscriptions
  • Add support for broadcasting time
  • Add WebSocket clear session and publish status
  • Add foxglove schemas with example

Docs: Introduction | Reference: Rust, Python, C++ | Source: github | C++ Artifacts: github

Foxglove 2.28.0

🧮 Write your own source-controlled scripts for manipulating data

We've added a new type of Foxglove extension that allows you to manipulate data and create new topics on the fly for visualization.

Semantically, these new topic message converters are similar to user scripts, but they are available across layouts and can be used to deploy "user-scripts" organization-wide. Like other extensions, they support code reuse, development in your own IDE, and use of third-party modules.

What used to be called a message converter is now called a schema message converter (schema converter for short). This new type of extension is called a topic message converter (topic converter).

How are the new Topic Message Converters different?

Topic converters are more flexible than schema converters. Where schema converters assume a 1:1 relationship between proprietary schemas and well-known schemas, topic converters do not have this restriction. They can produce new topics from one or more input topics. These new topics can output custom types or other well-known schemas.

Topic converters support:

  • One or more input topics
  • Maintaining state (you can aggregate signal data from previous input messages to produce new output—allowing you to make filters or perform arbitrary math on signal data)
  • Extract individual fields from a message to separate top-level topics
  • View output of new topics in plots and State Transition panels (or any panels that use range subscriptions)

When should Schema Message Converters be used?

We recommend using these when there is a 1:1 relationship between some internal schema and a well-known schema. Common examples:

  • Converting proprietary GPS messages to foxglove.LocationFix for display in the Map panel
  • Converting internal Log messages to foxglove.Log for the Log panel
  • Converting business logic to foxglove.SceneUpdate for display in the 3D panel

📒 Multi-file upload

You can now select multiple files and upload them simultaneously from the app.

New & Improved
  • Updated GridMap icon to match OccupancyGrid and FoxgloveGrid topics
  • When visualizing a ULog data source, the last message on a topic is now displayed after seeking
  • Visualization now shows an error when a 3D panel entity is rendered with a likely incorrect pose due to mismatched timestamps
  • Added the ability to quickly hide or show all series in the plot panel
  • Added the ability to hide or show all transforms, while preserving individual frame visibility, in the 3D panel
  • Tooltips for message path plots are now hidden for undefined series
  • Proximity in both x and y dimensions is now used to select points for tooltips in plots
  • Removed the vertical bar when hovering over non-time-series plots
  • Improved Map panel auto-centering
  • Moved the plot legend visibility toggle to the panel toolbar
  • Drag area is now only rendered in charts where sync is enabled
  • Added the ability to delete unimported device recordings
Performance
  • Improved memory performance of path-based XY plots to support larger datasets
  • Improved memory usage for 3D scenes with many transparent arrows
  • General performance improvements
Fixes
  • Fixed Quick Look previews not appearing on macOS
  • Resolved occasional 3D panel crashes with older versions of the ROS GridMap message type
  • Fixed GridMaps indexing and displaying data incorrectly when the size changes
  • GridMaps orientation now matches RViz
  • Fixed unsupported color settings appearing for Grid layers
  • Fixed timestamp truncation in filenames when downloading images from the image panel
  • Fixed retry getting into an unrecoverable state from network errors while seeking
  • Fixed playback head racing forward past cached regions after a network interruption
  • Fixed plot tooltip showing after panning, even if the mouse is not over a point
  • Fixed an issue with dropping H.265 video topics into the image panel

Downloads: Linux: deb amd64 arm64, snap amd64 | Windows: Universal | Mac: Universal

Agent v1.4.2

Agent

This release contains a fix for the filesystem watcher, and adds a new configuration flag for toggling filesystem notifications.

Added
  • Added WATCH_USE_NOTIFY, which can be used to toggle filesystem notifications.
Fixed
  • Fixed a bug introduced in v1.3.0, where the agent filesystem watcher may deadlock and fail to pick up new recordings.

Docs: About, Install | Debian Packages: amd64, arm64 | Binary Files: amd64, arm64

Agent v1.4.1

Agent

This release contains a fix for upload timeouts.

Fixed
  • Fixed a bug introduced in v1.3.3, where the agent would time out data uploads to foxglove-hosted storage.

Docs: About, Install | Debian Packages: amd64, arm64 | Binary Files: amd64, arm64

Agent v1.4.0

Agent

This release of the agent features a new TLS implementation and a statically-linked binary.

Changed
  • Switched from OpenSSL to rustls.
  • Removed the runtime dependency on glibc by statically linking the agent binary against musl.

Docs: About, Install | Debian Packages: amd64, arm64 | Binary Files: amd64, arm64

Foxglove 2.27.1

This release contains minor feature and performance improvements.

New & Improved
  • Renaming a previously deleted and then restored extension is now allowed
  • The measurement tools now show distance for all path-based plots, not just those with a 1:1 axis scale
Performance
  • Improved 3D panel performance for scene entity arrows when there are many scene entities

Downloads: Linux: deb amd64 arm64, snap amd64 | Windows: Universal | Mac: Universal

Foxglove 2.27.0

⛰️ Support for Grid Maps in 3D

We've added support for visualizing grid_map_msgs/GridMap messages in Foxglove. Grid Maps can be used to represent and visualize 2.5D height map information as well as other layers in the 3D panel. Common data layers stored in GridMap include elevation, variance, color, friction coefficient, foothold quality, surface normal, traversability, and more.

For visualizing surfaces in the 3D panel, Foxglove currently supports two interpolation methods between points:

  • Nearest neighbour: Creates cube volumes at the nearest grid point containing the elevation data (faster, less accurate representation of the surface).
  • Linear: The value of any point (x, y) on the surface is estimated using bilinear interpolation or the four neighboring grid points (slower, more accurate representation of the surface).

📐 Inspect and measure points in the Plot panel

We've added inspect and measurement tools to the Plot panel. With the tool enabled, you can click on any point to highlight its x and y-values. Select a second point to view the x and y-delta between the points. Additionally, when viewing a path-based XY plot (as opposed to a time-series plot), the tool will also display the Euclidean distance between the two points.

🔬 Easier zooming in the Plot panel

We've updated how you zoom in the Plot panel for a faster and more intuitive experience. When scrolling to zoom, hold Shift to zoom in y-axis and Alt/Option to zoom in the x-axis modifiers. You can also scroll either axis by hovering over the respective axis area for the plot.

📜 Quickly scroll through State Transitions

If your State Transitions panel contains a large number of rows, you can now use Shift + Scroll to quickly scroll through them.

New & Improved
  • Topics from scripts or converters are labeled as "from Script" or "from Converter" for topics generated by User Scripts or Converters respectively
  • Non-critical URDF issues now appear as warnings instead of errors
  • Added support for automatic min, max, and range detection for plots and state transitions using custom timestamp sources
Performance
  • Added a "Compute vertex normals" toggle in the 3D panel to improve performance for large meshes
  • Reduced initial opening time for ULog files
  • Improved support for larger ULog files, enabling review of longer flight logs
Fixes
  • Fixed an issue in the Plot panel where points were not displayed as expected
  • Copying bigint values in the Raw Messages panel now copies them as numbers, not quoted strings
  • Fixed a bug where certain paths would crash the Raw Messages panel
  • Fixed an issue where the 3D panel transform tree frame list could get shuffled during looped playback
  • Reduced flickering while streaming plot data
  • Fixed a point cloud bug where some points would linger when in cube mode
  • Fixed an issue where schemaless topics would not load from a streaming source
  • Fixed an issue where holding down z rapidly toggled the zoom tool
  • Fixed the "Retry" button after a network interruption
  • Fixed an issue where Plot and State Transitions panels would get stuck at deep zoom levels
  • Fixed an issue in the Image panel where large images could fail to synchronize with their annotations

Downloads: Linux: deb amd64 arm64, snap amd64 | Windows: Universal | Mac: Universal

SDK v0.7.1

Foxglove SDK

Python

  • Context is now available for associating channels and sinks.

Rust

  • Some handler types on WebSocket FetchAsset and Service have changed.
  • The log! macro properly re-uses matching channels.

C++

  • Context is now available for associating channels and sinks.
Fixed
Changed

Docs: Introduction | Reference: Rust, Python, C++ | Source: github | C++ Artifacts: github