# 通用规则
- 插件名称:见词知意(让不懂程序的人,看到名字和描述信息后,能明白这个程序的作用)
- 插件 ID\代号:
- 前端:英文+‘_’(禁止使用其他符号)
- 后端:英文+‘ . _ - ’(禁止使用其他符号)
- 图标:请设计师设计正式的图标,前后端使用相同图标
- 描述:简短描述本程序实现的功能
- 版本:a.b.c 均正整数
- a 主版本号 当功能模块有较大的变动,比如增加多个模块或者整体架构发生变化。
- b 子版本号 当功能有一定的增加或变化,比如增加了对权限控制、增加自定义视图等功能。
- c 阶段版本号 一般是 Bug 修复或是一些小的变动,要经常发布修订版,时间间隔不限,修复一个严重的bug即可发布一个修订版。
- 手册:更新至 玄道智控线上文档 (opens new window) 的【模块使用】菜单下,每开发完一个功能模块,就要更新手册
- 功能介绍
- 使用手册
- 变更记录
# 前端插件描述文件 main.json 示例
字段含义可参考描述文件规范 (opens new window)
{
"name": "PLC控制插件",
"id": "ccs_plugin_plc",
"version": "0.0.1",
"icon": "ccs_plc_plugin_icon.png",
"description": "PLC控制插件",
"entry": [
"index.js"
],
"style": [
"index.css"
]
}
# 后端插件描述文件 daemon.json 示例
字段含义可参考描述文件规范 (opens new window)
{
"name": "通用中控",
"pkg": "com.sansi.ccs-pro",
"description": "通用中央控制系统(CCS Pro)",
"interpreter": "node",
"icon": "favicon.ico",
"version": "2.4.6",
"path": "ccs_pro.js",
"os": "",
"arch": "",
"port": 3436,
"port_type": "HTTP",
"doc": "https://ccs-pro.sansi.io/",
"api_doc": "http://{{currentIp}}:{{currentPort}}/docs/api/",
"homepage": "http://{{currentIp}}:{{currentPort}}",
"firewall_enable": true,
"firewall_ports": [
"3436"
],
"configs": [
{
"title": "服务端配置",
"type": "json",
"path": "{{home}}/Sansi/CCS-Platform/config/ccs-server.json",
"schema": "{{app}}/config/ccs-server.schema.zh_CN.json"
}
]
}
端口:在服务信息采集 (opens new window)中进行登记,确保端口不冲突
doc:程序使用手册(建议填写)
api_doc:API 文档地址(建议填写)
homepage:主页地址(建议填写)