01-Extensions概述

最新推荐文章于 2025-08-05 20:56:53 发布

༺疏影༻

最新推荐文章于 2025-08-05 20:56:53 发布

阅读量11

点赞数

CC 4.0 BY-SA版权

分类专栏： Foxglove Foxglove Extensions Ros 文章标签：机器人

原文链接：https://docs.foxglove.dev/docs/extensions

Foxglove 同时被 3 个专栏收录

3 篇文章

订阅专栏

Foxglove Extensions

3 篇文章

订阅专栏

Ros

3 篇文章

订阅专栏

Foxglove Extensions 概述

简介

Foxglove Extensions（扩展）允许您扩展Foxglove的功能，以更好地支持团队的独特工作流程。通过扩展，您可以构建定制面板、转换自定义消息为Foxglove支持的模式，以及为主题名称创建别名以便于可视化。

扩展类型

1. 自定义面板（Custom Panels）

虽然Foxglove提供了一套用于机器人数据可视化和调试的内置面板，但许多用户有特定领域的需求，这些需求无法通过现成的产品来满足。

特点：

允许您构建完整的面板
可以订阅各种主题上的消息
支持广告和发布功能
以最适合您工作流程的形式显示消息信息

适用场景：
当您的可视化或交互需求是定制的，且无法通过内置面板轻松解决时，自定义面板是理想选择。

2. 消息转换器（Message Converters）

消息转换器扩展允许您将消息从一种形式转换为另一种形式。有两种类型的转换器：

Schema转换器

功能： 将消息从一个模式转换为另一个模式
适用场景： 当某个内部模式与知名Foxglove模式之间存在1:1关系时
示例： 将自定义GPS消息转换为foxglove.LocationFix以在地图面板中可视化
转换类型： 1:1模式映射
输入源： 任何模式
状态处理： 无状态
输出： 知名模式

Topic转换器

功能： 从一个或多个输入主题生成新主题
特点： 比schema转换器更灵活，但实现面积更大
转换类型： 任意主题生成
输入源： 一个或多个特定主题
状态处理： 支持有状态
输出： 自定义或知名模式

重要提示： 消息转换器仅在面板订阅主题时按需运行。

3. 主题别名（Topic Aliases）

主题别名扩展允许您为数据源中的主题创建别名到新主题。Foxglove面板可以同时订阅别名主题和原始数据源的主题。

编写扩展

技术要求

语言支持： JavaScript或TypeScript
打包格式： .foxe文件
分发方式： 私有分发给您的Foxglove组织或通过注册表公开发布
Node.js版本： 14+

快速开始

创建扩展项目：

npm init foxglove-extension@latest my-extension-name

项目结构：
- 入口点：index.ts文件
- 必须导出：ExtensionModule（包含单个activate函数）
- activate函数接受：单个ExtensionContext参数

基本结构示例

import { ExtensionContext } from "@foxglove/extension";

export function activate(extensionContext: ExtensionContext) {
  // 注册面板
  extensionContext.registerPanel({
    name: "my-panel",
    initPanel: initMyPanel
  });
  
  // 注册消息转换器
  extensionContext.registerMessageConverter({
    type: "schema",
    fromSchemaName: "custom.Message",
    toSchemaName: "foxglove.Message",
    converter: (inputMessage, messageEvent) => {
      // 转换逻辑
      return convertedMessage;
    }
  });
  
  // 注册主题别名
  extensionContext.registerTopicAliases((args) => {
    // 别名逻辑
    return aliases;
  });
}