跳到主要内容

配置格式

为确保用户自定义开发的插件包可以正常导入到珞石应用程序中,用户需要严格按照标准格式编写插件包与配置文件,并且保证配置文件名与插件名一致。

插件包

插件包可同时包含客户端和控制器插件。对应的压缩包命名需固定为 client.zip(客户端插件)controller.zip(控制器插件)

/**插件的文档目录**/
example.zip
├── client.zip
└── controller.zip
tips: 客户端插件和控制器插件都可以不依赖对方单独加载!

数据包

client.zip
├── plugin1
| ├──plugin1.lic
| ├──plugin1.dll
| ├──xplugin.dll
| └──plugin1.json
└── plugin2
| ├──plugin2.lic
| ├──plugin2.so
| ├──xplugin.so
| └──plugin2.json
|
// 其他客户端插件包

controller.zip
├── plugin1
| ├──plugin1.lic
| ├──plugin1.so
| └──plugin1.json
└── plugin2
| ├──plugin2.lic
| ├──plugin2.so
| └──plugin2.json
|
// 其他控制器插件包

配置文件

用户在开发客户端插件时,需要严格遵守标准配置文件(插件名.json)的格式,并且保证插件名称与配置文件中设置的名称一致。

{
"client_plugin":{
"name":"plugindemo", // 插件名,与插件文件名称保持一致,必填项
"depend":["plugin1","plugin2"], // 依赖客户端插件,选填
"ctrlDepend":[], // 依赖控制器插件,选填
"enable":false, // 加载后插件启用状态,默认加载后不启用,必填项
"version":"3.0.1", // 插件版本号 必填项
"min_hmi_version":"3.0.1", // 最小支持的HMI版本号(xCore版本号),选填
"custom_hmi_version":[], // 自定义适配的版本,选填
"author":"rokae", // 作者,选填
"description":"description" // 描述,选填
}
}

示例

以plugindemo插件名,制作的客户端插件与控制器插件集合包如下示例。plugindemo.zip是最终导入的插件包。

  plugindemo.zip                      // 压缩包
├── client.zip // 压缩包
| ├── plugindemo // 文件夹
| ├── plugindemo.lic
| ├── plugindemo.dll
| ├── xplugin.dll
| └── plugindemo.json
└── controller.zip // 压缩包
├── plugindemo // 文件夹
├── plugindemo.lic
├── plugindemo.so
└── plugindemo.json