config

Documentation

Overview

Package config 核心配置

Index

• type Action
• type Config
  • func (c Config) Validate() error
• type Device
• type DeviceAction
• type DeviceBase
• type DeviceModel
• type DriverConfig
• type Model
• type ModelBase
• type ModelCache
• type Point
• type PointBase
• type PointMap
  • func (pm PointMap) ToPoint() Point
• type ReadPointsAction
• type ResourceOperation
• type TimerTask

Types

type Action

type Action struct {
	DeviceNames []string `json:"devices"`
	Points      []string `json:"points"`
}

Action todo: 待删除

type Config

type Config struct {
	// 设备模型
	DeviceModels []DeviceModel `json:"deviceModels" validate:"required"`
	// 连接配置
	Connections map[string]interface{} `json:"connections" validate:"required"`
	// 协议名称（通过协议名称区分连接模式：客户端、服务端）
	ProtocolName string `json:"protocolName" validate:"required,oneof=http_server tcp_server modbus mqtt bacnet http_client"`
	// 配置唯一key，一般对应目录名称
	Key string `json:"-" validate:"-"`
	// 定时任务
	Tasks []TimerTask `json:"timerTasks" validate:"-"`
}

Config 配置

func (Config) Validate

func (c Config) Validate() error

Validate 核心配置文件校验

type Device

type Device struct {
	DeviceBase
	// 连接 Key
	ConnectionKey string `json:"connectionKey" validate:"required"`
	// 协议参数
	Protocol map[string]string `json:"protocol" validate:"-"`
}

Device 设备

type DeviceAction

type DeviceAction struct {
	// 操作名称
	Name string `json:"name" validate:"required"`
	// 读写类型：RW、R、W
	ReadWrite string `json:"readWrite" validate:"required|oneof=R W RW"`
	// 资源操作列表
	ResourceOperations []ResourceOperation `json:"resourceOperations" validate:""`
}

DeviceAction 设备操作

type DeviceBase

type DeviceBase struct {
	// 设备名称
	Name string `json:"name" validate:"required"`
	// 模型名称
	ModelName string `json:"-" validate:"-"`
	// 设备描述
	Description string `json:"description" validate:"required"`
}

DeviceBase 设备基础信息

type DeviceModel

type DeviceModel struct {
	ModelBase
	// 模型点位列表
	DevicePoints []PointMap `json:"devicePoints" validate:"required"`
	// 模型操作列表
	DeviceActions []DeviceAction `json:"deviceActions" validate:""`
	// 设备列表
	Devices []Device `json:"devices" validate:"required"`
}

DeviceModel 设备模型

type DriverConfig

type DriverConfig struct {
	LoggerLevel      string // 日志等级
	PointCacheTTL    int64  // 点位缓存默认过期时间，单位：秒
	DefaultDeviceTTL int    // 默认设备影子生命周期
}

type Model

type Model struct {
	ModelBase
	Points  map[string]PointBase  `json:"points"`
	Devices map[string]DeviceBase `json:"devices"`
}

type ModelBase

type ModelBase struct {
	// 模型名称
	Name string `json:"name" validate:"required"`
	// 云端模型 ID
	ModelID string `json:"modelId" validate:"required"`
	// 模型描述
	Description string `json:"description" validate:"required"`
}

ModelBase 模型基础信息

type ModelCache

type ModelCache struct {
	ModelBase
	Points map[string]PointBase
}

ModelCache 模型缓存

type Point

type Point struct {
	PointBase
	// 扩展参数
	Extends map[string]interface{} `json:"-" validate:"-"`
}

Point 点位数据

type PointBase

type PointBase struct {
	// 点位名称
	Name string `json:"name" validate:"required"`
	// 点位描述
	Description string `json:"description" validate:"required"`
	// 值类型
	ValueType string `json:"valueType" validate:"required,oneof=int float string"`
	// 读写模式
	ReadWrite string `json:"readWrite" validate:"required,oneof=int float string"`
	// 实时上报开关
	RealReport bool `json:"realReport" validate:"required,boolean"`
	// 定时上报
	TimerReport string `json:"timerReport" validate:"required"`
	// 单位
	Units string `json:"units" validate:"-"`
	// 上报模式
	ReportMode string `json:"reportMode" validate:"required"`
}

PointBase 点位基础信息

type PointMap

type PointMap map[string]interface{} // 点位 Map，可转换为标准点位数据

func (PointMap) ToPoint

func (pm PointMap) ToPoint() Point

ToPoint 转换为标准点位数据

type ReadPointsAction

type ReadPointsAction struct {
	DeviceNames []string `json:"devices"`
	Points      []string `json:"points"`
}

type ResourceOperation

type ResourceOperation struct {
	// 设备资源名称
	DeviceResource string `json:"deviceResource" validate:"-"`
	// 资源默认值
	DefaultValue string `json:"defaultValue" validate:"-"`
	// 资源扩展参数
	Mappings map[string]string `json:"mappings" validate:"-"`
}

ResourceOperation 资源操作

type TimerTask

type TimerTask struct {
	// 间隔（单位：毫秒）
	Interval string `json:"interval" validate:"required"`
	// 任务类型
	Type string `json:"type" validate:"required"`
	// 任务动作
	Action interface{} `json:"action" validate:"required"`
}

TimerTask 定时任务