进程模式软网关自定义驱动开发

更新时间：2023-07-10

功能简介

进程模式使用了和容器模式不一样的数采上报架构，使用了软网关模块。该模块大大简化了自定义协议驱动开发难度，当有新增驱动协议时，用户只需要开发数据采集插件，由软网关模块来完成数据的清洗、转换、上报。且数采插件开发与语言无关，用户可以使用任意支持的语言进行插件开发（容器模式自定义协议驱动仅支持go语言）。架构图如下

流程图-202306301613.png

操作指南

当前平台内置的协议包含modbus tcp、modbus rtu、bacnet、iec104、opcua、opcda，5种不同类型的协议。若用户有其余的协议设备接入需求，可以参考软网关自定义协议驱动开发文档。

软网关部署

用户创建产品、设备、接入模版后，可在节点的子设备管理界面，进行设备与节点的绑定。具体操作步骤可参考文档‘子设备绑定’。相关信息填写完毕后，点击部署软网关，会向边缘节点下发baetyl-gateway-{nodename}应用。

软网关程序为主进程，主进程下会挂载针对不同协议插件的子进程。

自定义驱动开发

架构图

简介

1、baetyl-gateway采用go-plugin框架开发，宿主进程与插件进程间通过gRPC方式通信，插件进程只需实现指定接口即可。

2、插件实现语言无关，用户可自定选择熟悉的语言进行开发，只需要实现下述固定接口即可。

3、宿主进程与插件进程间接口列表

type Driver interface {
	GetDriverInfo(req *Request) (*Response, error)
	SetConfig(req *Request) (*Response, error)
	Setup(config *BackendConfig) (*Response, error)
	Start(req *Request) (*Response, error)
	Restart(req *Request) (*Response, error)
	Stop(req *Request) (*Response, error)

	Get(req *Request) (*Response, error)
	Set(req *Request) (*Response, error)
}

type Report interface {
	// 驱动 --> 宿主
	Post(req *Request) (*Response, error)
	State(req *Request) (*Response, error)
}

开发指南

主进程中开启gRPC服务，监听宿主进程调用请求

func main() {
    if err := plugin.Serve(&plugin.ServeOpts{
        // 工厂函数返回插件进程用于实现指定接口的结构体实例
		FactoryFunc: modbus.NewDriver,
	}); err != nil {
		logger := hclog.New(&hclog.LoggerOptions{})
		logger.Error("plugin modbus shutting down", "error", err)
		os.Exit(1)
	}
}

type Driver struct {
	driverName string
	configPath string
	report     plugin.Report
	mds        *Modbus
	log        hclog.Logger
}

func NewDriver(_ context.Context, cfg *plugin.BackendConfig) (plugin.Driver, error) {
	b := &Driver{log: cfg.Log}
	return b, nil
}

插件实现指定接口

插件侧server 宿主侧client

// 
GetDriverInfo 
获取驱动信息
func (d *Driver) GetDriverInfo(req *plugin.Request) (*plugin.Response, error) {
	return nil, nil
}

// SetConfig 配置驱动，目前只配置了驱动的配置文件路径
func (d *Driver) SetConfig(req *plugin.Request) (*plugin.Response, error) {
	d.configPath = req.Req
	return &plugin.Response{Data: fmt.Sprintf("Plugin %s SetConfig success", d.driverName)}, nil
}

// Setup 宿主进程上报接口传递，必须调用下述逻辑，其余可用户自定义
func (d *Driver) Setup(config *plugin.BackendConfig) (*plugin.Response, error) {
	d.driverName = config.DriverName
	d.report = config.ReportSvc
	return &plugin.Response{Data: fmt.Sprintf("Plugin %s Setup success", d.driverName)}, nil
}

// Start 驱动采集启动，用户自定义实现
func (d *Driver) Start(req *plugin.Request) (*plugin.Response, error) {
	return nil, nil
}

// Restart 驱动重启，用户自定义实现
func (d *Driver) Restart(req *plugin.Request) (*plugin.Response, error) {
	return nil, nil
}

// Stop 驱动停止，用户自定义实现
func (d *Driver) Stop(req *plugin.Request) (*plugin.Response, error) {
	return nil, nil
}

// Get 召测，用户自定义实现
func (d *Driver) Get(req *plugin.Request) (*plugin.Response, error) {
    return nil, nil
}

// Set 置数，用户自定义实现
func (d *Driver) Set(req *plugin.Request) (*plugin.Response, error) {
    return nil, nil
}

插件侧client 宿主侧server

// 插件侧采集上报接口，指定消息类型 MessageDeviceReport
func (m *ReportImpl) Post(req *plugin.Request) (*plugin.Response, error) {
	msg := &v1.Message{}
	err := json.Unmarshal([]byte(req.Req), msg)
	if err != nil {
		return nil, err
	}
	switch msg.Kind {
	case v1.MessageDeviceReport:
		select {
		case m.msgCh <- msg:
		default:
			m.log.Error("failed to write device report message", log.Any("msg", msg))
		}
	default:
		m.log.Error("message kind not supported", log.Any("type", msg.Kind))
	}

	return &plugin.Response{Data: fmt.Sprintf("msg kind: %s post success", msg.Kind)}, nil
}

// State 驱动状态上报接口，驱动调用，消息放入channel，指定消息类型 MessageDeviceLifecycleReport
func (m *ReportImpl) State(req *plugin.Request) (*plugin.Response, error) {
	msg := &v1.Message{}
	err := json.Unmarshal([]byte(req.Req), msg)
	if err != nil {
		return nil, err
	}
	switch msg.Kind {
	case v1.MessageDeviceLifecycleReport:
		select {
		case m.msgCh <- msg:
		default:
			m.log.Error("failed to write device state message", log.Any("msg", msg))
		}
	default:
		m.log.Error("message kind not supported", log.Any("type", msg.Kind))
	}
	return &plugin.Response{Data: fmt.Sprintf("msg kind: %s state success", msg.Kind)}, nil
}


// 插件侧调用示例，插件侧setup后，上报接口实现传递至插件侧，插件只需调用即可
res, err := w.driver.report.Post(&plugin.Request{Req: string(msgData)})

res, err = s.driver.report.State(&plugin.Request{Req: string(msgData)})

消息类型

// 采集上报
MessageDeviceReport MessageKind = "deviceReport"

// 状态上报
MessageDeviceLifecycleReport MessageKind = "thing.lifecycle.post"

// 置数消息
MessageDeviceDelta MessageKind = "deviceDelta"

// 召测消息
MessageDevicePropertyGet MessageKind = "thing.property.get"

软网关主配置文件

软网关主配置文件，包含插件配置，apiserver配置及mqtt配置
插件配置包含插件名(需与二进制文件同名)、bin文件路径、配置文件路径
apiserver为插件管理server
mqtt配置，如果不配置，则默认连接bie的系统应用baetyl-broker

plugin:
  drivers:
    - name: modbus
      binPath: "etc/modbus"
      configPath: "etc/modbus"
server:
  port: ":9889"
mqttConfig:
  address: mqtt://127.0.0.1:8963
  cleansession: true
  username: test
  password: hahaha

插件配置文件

sub_devices.yml

『节点管理』-『子设备管理』中的驱动配置和子设备配置信息存放在sub_device.yml中

devcies[i].accessConfig.custom为子设备的配置
driver为驱动配置

devices:
- name: device1
  version: 1663240313luvrs4
  deviceModel: device-model
  accessTemplate: device-access-tpl
  deviceTopic:
    delta:
      qos: 1
      topic: thing/device-model/device1/property/invoke
    report:
      qos: 1
      topic: thing/device-model/device1/property/post
    event:
      qos: 1
      topic: thing/device-model/device1/raw/c2d
    get:
      qos: 1
      topic: $baetyl/device/device1/get
    getResponse:
      qos: 1
      topic: $baetyl/device/device1/getResponse
    eventReport:
      qos: 1
      topic: thing/device-model/device1/event/post
    propertyGet:
      qos: 1
      topic: thing/device-model/device1/property/get
    lifecycleReport:
      qos: 1
      topic: thing/device-model/device1/lifecycle/post
  accessConfig:
    custom: |-
      channelId: test-chan-01
      machineNumber: N001L01.101
driver: |-
  channels:
  - name: test-chan-01
    address: 192.168.0.1:23
    interval: 30s

models.yml

『子设备管理』-『产品』中的产品测点信息存放在models.yml中

device-model:
- name: switch
  type: bool
  mode: rw
- name: temperature
  type: float32
  mode: ro
- name: humidity
  type: float32
  mode: ro
- name: high-temperature-threshold
  type: int32
  mode: rw
- name: high-temperature-alarm
  type: bool
  mode: ro

access_template.yml

『子设备管理』-『接入模板』中的设备点表和物模型点位映射信息存放在access_template.yml中

device-access-tpl.properties[i].visitor.custom为设备点表信息中的采集配置
device-access-tpl.properties[i].mapping为物模型点位映射信息

device-access-tpl:
  properties:
  - name: 高温报警
    id: "1"
    type: bool
    visitor:
      custom: |-
        start: 1
        offset: 14
  mappings:
  - attribute: high-temperature-alarm
    type: value
    expression: x1

自定义驱动开发指南

GO语言实现示例

百度智能云

智能边缘 BIE