lubin502831 / hw-plugin-weather

瀚文助手上位机的天气插件

天气插件

---

瀚文扩展的天气插件

构建方法

Windows

go build -buildmode=c-shared -o bin/life.win -tags stdc -ldflags="-s -w" main.go plugin.go

Linux

go build -buildmode=c-shared -o bin/life.linux -tags stdc -ldflags="-s -w" main.go plugin.go

Mac

go build -buildmode=c-shared -o bin/life.mac -tags stdc -ldflags="-s -w" main.go plugin.go

---

代码说明

plugin.go

PluginRegister() char*

插件第一次注册时会调用这个接口,需要构造一串C风格JSON文本还给上位机.
无需管理内存问题,上位机会自己释放.

示例

{
  "name":"插件名称",
  "version": "插件版本",
  "author": "作者",
  "description": "插件说明"
}

---

PluginUnRegister() bool

插件卸载时会调用这个接口,返回bool类型

---

PluginInit(char*)

插件第一次初始化会调用,整个生命周期内也只会调用一次,传入一个json字符串

示例

{
  "enable": true, // 是否启用
  "name":"插件名称",
  "version": "插件版本",
  "author": "作者",
  "description": "插件说明",
  "raw_name": "标示名称",
  "plugin_path": "插件的目录,创建的文件不应超出此目录,请规范使用参数",
  "calls": [ // 主动方法,例如主动推送墨水屏图片等
    {
      "name": "主动方法名称",
      "address": "主动方法地址"
    }
  ]
}

PluginConfigUI() char*

上位机请求配置页面数据

示例

{
  "widgets": [ // 一个widgets一行
    [
      {
        "Type": "text", // 组件类型
        "Text": "和风天气秘钥", // 标题/文本内容
        "Layout": 2 // 布局百分比,2代表20%
      },
      {
        "Type": "input",
        "Bind": "weather_key", // 绑定数据,后续接口使用,同一个插件内不要有重复bind
        "Text": "xxxx",
        "Layout": 8 // 布局百分比,80%
      }
    ],
    [
      {
        "Type": "checkbox",
        "Text": "付费接口(免费订阅秘钥不能勾选)",
        "Bind": "weather_api_business",
        "Layout": 5
      }
    ]
  ]
}

组件Type说明

类型	注释
text	标签
input	输入框
checkbox	多选框
divider	分隔条
submit	提交按钮

---

PluginSaveConfig(char*) bool

插件页面会有一个保存配置按钮,那个按钮按下时的事件 传入一个C风格JSON

示例

{
  "weather_key": "xxx" // 上面创建的input有个Bind,此处key对应Bind,value对应编辑框内的数据
  "weather_api_business": false // 多选框为bool类型
}

---

PluginTimedEvent() bool

上位机不定期的Tick事件,有可能是10S,也有可能是20S

---

PluginSubmit(char*) bool

submit组件按下会触发这个事件

示例

{
  "config": { // 与PluginSaveConfig内结构一致
    "city_id": "",
    "weather_api_business": false,
    "weather_key": ""
  },
  "event_bind": "weather_update" // 事件来源
}

---

PluginGetLastError() char*

当任何带有bool返回值的插件返回false时,会请求一次这个接口获取错误信息