跳到主要内容

插件命令

用于管理插件目录、已安装插件副本、启用状态和扩展页面的命令。

版本说明

本页补充的扩展管理命令与元数据字段在 3.0.0-dev.4 及之后版本可用。

get_plugins​

返回所有已安装灯效、控制器和扩展插件的元数据。

参数：无

→ {"jsonrpc":"2.0","method":"get_plugins","id":1}
← {"jsonrpc":"2.0","result":{
  "effects": [
    {
      "id": "rainbow",
      "name": {"raw": "Rainbow", "byLocale": {"zh-CN": "彩虹"}},
      "enabled": true,
      "description": {"raw": "Flowing rainbow animation"},
      "icon": "Waves",
      "permissions": ["log"],
      "version": "1.0.0",
      "publisher": "Skydimo",
      "language": "native-c",
      "abi": "skydimo-effect-c-v3",
      "repository": "https://github.com/...",
      "license": "MIT",
      "params": [],
      "pluginDir": "...",
      "dataDir": "...",
      "bundled": false,
      "installSource": "import-dev",
      "reimportsOnRefresh": false
    }
  ],
  "controllers": [
    {
      "id": "skydimo_serial",
      "name": {"raw": "Skydimo Serial"},
      "enabled": true,
      "version": "1.0.0",
      "publisher": "Skydimo",
      "language": "lua",
      "pluginDir": "...",
      "bundled": true,
      "installSource": "bundled",
      "reimportsOnRefresh": false
    }
  ],
  "extensions": [
    {
      "id": "led_canvas",
      "name": {"raw": "LED Canvas"},
      "enabled": true,
      "version": "1.0.0",
      "publisher": "Skydimo",
      "language": "native-c",
      "abi": "skydimo-extension-c-v2",
      "page": {"type": "path", "value": ".../page/dist/index.html"},
      "pluginDir": "...",
      "bundled": false,
      "installSource": "import-dev",
      "reimportsOnRefresh": false
    }
  ]
},"id":1}

每个插件项可包含：

字段类型说明
idstring插件 ID
nameLocalizedText显示名称
enabledboolean是否启用
versionstringManifest 版本
publisherstringManifest 发布者
languagestring运行时语言，如 lua 或 native-c
abistring | nullnative-c 插件的 ABI 标识符
repositorystring | null源仓库 URL
licensestring | null许可证标识符
pluginDirstring插件运行时目录
dataDirstring | null插件数据目录（若存在）
bundledboolean是否随应用打包
installSourcestringbundled | import | import-dev | package | manual
reimportsOnRefreshboolean刷新时是否可从来源队列重新导入
pageobject | null扩展页面来源（如果扩展声明了页面）

refresh_plugins​

刷新插件状态并处理导入队列。

参数：无

→ {"jsonrpc":"2.0","method":"refresh_plugins","id":1}
← {"jsonrpc":"2.0","result":null,"id":1}

通常会触发：

  • 处理导入队列
  • 重载插件注册表
  • 刷新运行时状态，使插件更新生效
  • 向 UI 发送插件变更事件

open_plugin_dir​

在系统文件管理器中打开插件总目录，或指定插件的解析目录。

参数：

字段类型必填说明
pluginIdstring否传入时打开指定插件目录；不传时打开插件总目录
→ {"jsonrpc":"2.0","method":"open_plugin_dir","params":{"pluginId":"rainbow"},"id":1}
← {"jsonrpc":"2.0","result":null,"id":1}

open_plugin_data_dir​

在系统文件管理器中打开指定插件的数据目录。

参数：

字段类型必填说明
pluginIdstring是插件 ID
→ {"jsonrpc":"2.0","method":"open_plugin_data_dir","params":{"pluginId":"rainbow"},"id":1}
← {"jsonrpc":"2.0","result":null,"id":1}

delete_plugin​

删除已安装的用户插件副本。

参数：

字段类型必填说明
pluginIdstring是插件 ID
deleteDataboolean否是否同时删除插件数据目录
→ {"jsonrpc":"2.0","method":"delete_plugin","params":{
  "pluginId":"my_effect",
  "deleteData":true
},"id":1}
← {"jsonrpc":"2.0","result":null,"id":1}
警告

应用打包插件不可直接删除，需使用 reset_plugin。

reset_plugin​

重置插件：移除用户覆盖副本并回到默认打包版本。

参数：

字段类型必填说明
pluginIdstring是插件 ID
resetDataboolean否是否同时重置插件数据
→ {"jsonrpc":"2.0","method":"reset_plugin","params":{
  "pluginId":"rainbow",
  "resetData":false
},"id":1}
← {"jsonrpc":"2.0","result":null,"id":1}

get_plugin_dir​

获取插件总目录路径。

参数：无

→ {"jsonrpc":"2.0","method":"get_plugin_dir","id":1}
← {"jsonrpc":"2.0","result":"C:/.../plugins","id":1}

set_controller_plugins_enabled​

启用或禁用控制器插件。

参数：

字段类型必填说明
pluginIdsstring[]是控制器插件 ID 列表
enabledboolean是true 启用，false 禁用
→ {"jsonrpc":"2.0","method":"set_controller_plugins_enabled","params":{
  "pluginIds":["skydimo_serial"],
  "enabled":true
},"id":1}
信息

禁用控制器插件会断开所有当前由该插件管理的设备。

set_effect_plugins_enabled​

启用或禁用灯效插件。

参数：

字段类型必填说明
pluginIdsstring[]是灯效插件 ID 列表
enabledboolean是true 启用，false 禁用
→ {"jsonrpc":"2.0","method":"set_effect_plugins_enabled","params":{
  "pluginIds":["rainbow"],
  "enabled":true
},"id":1}

set_extension_plugins_enabled​

启用或禁用扩展插件。

参数：

字段类型必填说明
pluginIdsstring[]是扩展插件 ID 列表
enabledboolean是true 启用，false 禁用
→ {"jsonrpc":"2.0","method":"set_extension_plugins_enabled","params":{
  "pluginIds":["openrgb"],
  "enabled":false
},"id":1}

ext_page_send​

向扩展插件的内嵌页面发送消息。

参数：

字段类型必填说明
extIdstring是扩展插件 ID
dataany是要发送的任意 JSON 数据
→ {"jsonrpc":"2.0","method":"ext_page_send","params":{
  "extId":"openrgb",
  "data":{"action":"refresh"}
},"id":1}

Lua 扩展通过 on_page_message(data) 接收此消息。native-c 扩展通过 on_page_message_json 接收。

插件下载会话命令​

用于下载并安装插件的会话流程。

start_download_plugin_session​

从远程来源创建服务端下载会话。

install_from_plugin_session​

从会话中选择插件并安装到托管插件存储。

cancel_download_plugin_session​

取消并清理下载会话。

备注

开发版本中的精确请求/响应结构可能迭代。做工具接入时，请以目标构建版本的数据类型文档为准。