智汀家庭云-快速入门：开发第一个插件

开发第一个插件

本文介绍了如何为插件开发人员开发简单的插件。

开发前先阅读插件设计概要：智汀家庭云-开发指南Golang： 插件模块

1. 插件实现

1. 获取sdk

go get gi


1. 定义设备

package plugin

import "gi/pkg/plugin/sdk/instance"

type Device struct {
Light in
Info0 in
// 根据实际设备功能组合定义
}

func NewDevice() *Device {
return &Device{
Light: in(),
Info0: in(),
}
}


1. 实现设备接口

package plugin

import (
"gi/pkg/plugin/sdk/instance"
"gi/pkg/plugin/sdk/server"
)

type Device struct {
Light in
Info0 in
// 根据实际设备功能组合定义
identity string
ch
}

func NewDevice() *Device {
return &Device{
Light: in(),
Info0: in(),
ch: make(, 10),
}
}

func (d *Device) Info() {
// 该方法返回设备的主要信息
return d.identity
}

func (d *Device) Setup() error {
// 设置设备的属性和相关配置（比如设备id、型号、厂商等，以及设备的属性更新触发函数）
d.In("123456")
d.In("model")
d.In("manufacturer")

d.Lig(1, 100)
d.Lig(1000, 5000)
d.Lig("power"))
d.Lig("brightness"))
d.Lig("color_temp"))
return nil
}

func (d *Device) Update() error {
// 该方法在获取设备所有属性值时调用，通过调用a()等方法更新
d.Lig("on")
d.Lig(100)
d.Lig(2000)
return nil
}

func (d *Device) Close() error {
// 自定义退出相关资源的回收
close)
return nil
}

func (d *Device) GetChannel() {
// 返回WatchChan频道，用于状态变更推送
return d.ch
}

1. 初始化和运行

package main

import (
"log"

"gi/pkg/plugin/sdk/server"
sdk "gi/pkg/server/sdk"
)

func main() {
p := ("demo")
go func() {
// 发现设备
d := NewDevice()
p.Manager.AddDevice(d)
}()
err := (p)
if err != nil {
log.Panicln(err)
}
}


2. 镜像编译和部署

暂时仅支持以镜像方式安装插件，调试正常后，编译成镜像提供给SA

• dockerfile示例参考

FROM golang:1.16-alpine as builder
RUN apk add build-base
COPY . /app
WORKDIR /app
RUN go env -w GOPROXY="go;
RUN go build -ldflags="-w -s" -o demo-plugin

FROM alpine
WORKDIR /app
COPY --from=builder /app/demo-plugin /app/demo-plugin

# static file
COPY ./html ./html
ENTRYPOINT ["/app/demo-plugin"]

• 编译镜像

docker build -f your_plugin_Dockerfile -t your_plugin_name


• 更多

智汀家庭云-开发指南Golang：设备插件开发

3. Demo

demo-plugin : 通过上文的插件实现教程实现的示例插件；这是一个模拟设备写的一个简单插件服务，不依赖硬件，实现了核心插件的功能