# 一、基本插件文件结构
>[success] 插件文件夹由主文件夹、插件配置文件、插件源码文件和其它资源文件组成
这里以一个简单的helloworld插件举例,你也可以通过插件市场直接下载helloworld插件样例查看。
![](http://qiniucn.16302.com/bf54580609a7965d921eb3b76999235c)
```shell
├── helloworld # 插件文件夹名称
│ ├── config.json # 插件配置文件
│ └── helloworld.py # 插件主程序文件
```
<br>
# 二、文件名命名规范
>[info] 文件夹名称为`helloworld`,那么插件程序名称必须为`helloworld.py`
![](http://qiniucn.16302.com/b8e20b20f25682a61e4603ec066b6ebf)
<br>
# 三、config文件规范
>[info] 我们可以看到插件文件夹里有一个config.json文件,这个文件是用于配置插件的各项属性的,比如插件是否自启动,插件是否打印出debug信息,插件的触发词等等,详细的插件各项属性请查看下列属性表单。
![](http://qiniucn.16302.com/cc127af40decbfd84d553fcbeb865bee)
```json
{
"name": "helloworld",
"triggerwords":["Hello", "你好世界"],
"IsEnable": true,
"IsSystem": false,
"AutoLoader": false,
"icon":"1",
"displayName": "基本的Hello World",
"description": "这里写简介,比如'这是一个Hello World文档'",
"version": "1.0.1",
"updateTime":"2022-06-22 13:25:10"
}
```
| 属性 | 功能 | 可选值 |
| --- | --- |---|
| name | 插件名,需要与插件文件夹名称一致 | "helloworld" |
| triggerwords | 插件的触发词 | ["触发词1","触发词2"] |
| IsEnable| 是否启用插件 | true,false |
| IsSystem| 是否为系统插件 | false,true |
| AutoLoader| 是否自动加载 | false,"start" |
| icon| 默认图标 | "1" |
| displayName| 插件的显示名 | "插件名称" |
| description| 插件的简介 | "插件的简介" |
| version| 插件版本 |"1.0.1" |
| updateTime| 更新时间 | "2022-06-22 13:25:10" |
<br>
# 四、插件主程序文件规范
>[info] 打开`helloworld.py`文件,这是插件的主程序文件,它在我们的系统里是以类(class)的方式提供的,你编写的插件的所有功能都是从这里开始的。
![](http://qiniucn.16302.com/65046086729499c9a01bcc95986a8bae)
`helloworld.py`源码
```python
from MsgProcess import MsgProcess, MsgType
class helloworld(MsgProcess):
def Text(self, message):
data="你好世界~ 我是智能小美"
self.send(MsgType.Text, Receiver='Screen', Data=data)
```
>[warning] 这段代码建议手动敲出来不要复制,复制会导致编码错误,尤其是Windows平台和Linux平台的CRLF和LF格式问题。
>[info] 请在条件允许的情况下手动将代码输入一遍
这段代码表示将字符串`data`的内容以`MsgType.Text`类型发送到 `Screen`也就是前端的屏幕
如果你对`send()`函数不理解请前往[插件消息机制](http://docs.16302.com/2987119)了解。
# 五、最终效果
![](http://qiniucn.16302.com/6db5b6aa8978ba60c17330905680c37b)
- 自美智能物联网系统简介
- 1.系统安装
- 树莓派上安装自美系统
- 香橙派上安装自美系统
- 普通电脑和虚拟机下安装自美系统
- 安装自美智能物联网系统
- 2.系统使用
- 获取设备IP地址
- 自美系统的启动与停止
- 进入控制面板
- 通过控制面板管理插件
- 控制面板系统配置
- 设置唤醒词
- 开启内网穿透服务
- 启用SSH管理设备
- 使用微信小程序
- 3.开发者中心
- [重要必看]插件消息机制
- 配置开发环境
- 开发自美插件
- 开发微信小程序插件
- 开发前端插件
- 系统内置模块说明
- Docker容器的使用方法
- Docker中使用摄像头
- 烧录ESP32单片机
- 4.树莓派相关
- 自美树莓派声卡驱动板使用说明
- 树莓派设备配网
- 树莓派启用VNC远程桌面
- 树莓派官方系统的烧录
- 树莓派启动远程SSH
- 树莓派使用GPIO编程
- 树莓派设备修改文件权限
- 5.香橙派相关
- 香橙派官方系统的烧录
- 香橙派使用SSH服务
- 6.电视盒子相关
- 电视盒子使用自美系统
- 将armbian刷入eMMc
- 卸载自美系统
- 老版本系统说明
- 联系我们