config

Documentation

Overview

Package config 核心配置

Index

• Constants
• Variables
• func IsVirtual() bool
• type Config
  • func (c Config) GetModelIndexes() map[string]int
  • func (c Config) UpdateIndexAndClean() Config
  • func (c Config) Validate() error
• type Device
• type DeviceBusinessProp
• type DeviceModel
  • func (dm DeviceModel) GetDeviceIndexes() map[string]int
• type EnvConfig
• type Model
• type ModelBase
• type Point
• type PointMap
  • func (pm PointMap) ToPoint() Point
• type ReadPointsAction
• type ReadWrite
• type ReportMode
• type TimerTask
• type ValueType

Constants

const (
	//资源文件存放目录
	ENV_RESOURCE_PATH = "DRIVERBOX_RESOURCE_PATH"
	//http服务监听端口号
	ENV_HTTP_LISTEN = "DRIVERBOX_HTTP_LISTEN"

	//日志文件存放路径
	ENV_LOG_PATH = "DRIVERBOX_LOG_PATH"

	//是否虚拟设备模式: true:是,false:否
	ENV_VIRTUAL = "DRIVERBOX_VIRTUAL"

	//场景联动配置存放目录
	ENV_LINKEDGE_CONFIG_PATH = "EXPORT_LINKEDGE_CONFIG_PATH"

	//镜像设备功能是否可用
	ENV_EXPORT_MIRROR_ENABLED = "EXPORT_MIRROR_ENABLED"

	//镜像设备功能是否可用
	ENV_EXPORT_DISCOVER_ENABLED = "EXPORT_DISCOVER_ENABLED"
)

环境变量配置项

Variables

var (
	//实时上报,读到数据即触发
	ReportMode_Real ReportMode = "realTime"
	//变化上报,同影子中数值不一致时才触发上报
	ReportMode_Change ReportMode = "change"
	//只读
	ReadWrite_R ReadWrite = "R"
	//只写
	ReadWrite_W ReadWrite = "W"
	//读写
	ReadWrite_RW ReadWrite = "RW"
	//点位类型：整型
	ValueType_Int ValueType = "int"
	//点位类型：浮点型
	ValueType_Float ValueType = "float"
	//点位类型：字符串
	ValueType_String ValueType = "string"
)

var ResourcePath = "./res"

资源文件目录

Functions

func IsVirtual

func IsVirtual() bool

是否处于虚拟运行模式：未建立真实的设备连接

Types

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"`
	// 配置唯一key，一般对应目录名称
	Key string `json:"-" validate:"-"`
	// contains filtered or unexported fields
}

Config 配置

func (Config) GetModelIndexes

func (c Config) GetModelIndexes() map[string]int

GetModelIndexes 获取模型索引

func (Config) UpdateIndexAndClean

func (c Config) UpdateIndexAndClean() Config

UpdateIndexAndClean 更新索引并清理无效数据 1. 更新模型、设备索引 2. 移除无效连接

func (Config) Validate

func (c Config) Validate() error

Validate 核心配置文件校验

type Device

type Device struct {
	// 设备 ID
	ID string `json:"id" validate:"required"`
	// 模型名称
	ModelName string `json:"-" validate:"-"`
	// 设备描述
	Description string `json:"description" validate:"required"`
	// 设备离线阈值，超过该时长没有收到数据视为离线
	Ttl string `json:"ttl"`

	//设备标签
	Tags []string `json:"tags"`
	// 连接 Key
	ConnectionKey string `json:"connectionKey" validate:"required"`
	// 协议参数
	Properties map[string]string `json:"properties" validate:"-"`

	//设备层驱动的引用
	DriverKey string `json:"driverKey"`
}

Device 设备

type DeviceBusinessProp

type DeviceBusinessProp struct {
	// SN 设备 SN
	SN string
	// ParentID 父设备 ID
	ParentID string
	// SystemID 所属系统 ID
	SystemID string
}

DeviceBusinessProp 设备业务属性

type DeviceModel

type DeviceModel struct {
	ModelBase
	// 模型点位列表
	DevicePoints []PointMap `json:"devicePoints" validate:"required"`
	// 设备列表
	Devices []Device `json:"devices" validate:"required"`
	// contains filtered or unexported fields
}

DeviceModel 设备模型

func (DeviceModel) GetDeviceIndexes

func (dm DeviceModel) GetDeviceIndexes() map[string]int

GetDeviceIndexes 获取设备索引

type EnvConfig

type EnvConfig struct {
	ConfigPath string
	//http服务监听端口号
	HttpListen string
	LogPath    string
}

type Model

type Model struct {
	ModelBase
	Points  map[string]Point  `json:"points"`
	Devices map[string]Device `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"`
	//扩展属性
	Attributes map[string]interface{} `json:"attributes"`
}

ModelBase 模型基础信息

type Point

type Point struct {
	// 点位名称
	Name string `json:"name" validate:"required"`
	// 点位描述
	Description string `json:"description" validate:"required"`
	// 值类型
	ValueType ValueType `json:"valueType" validate:"required,oneof=int float string"`
	// 读写模式
	ReadWrite ReadWrite `json:"readWrite" validate:"required,oneof=R W RW"`
	// 单位
	Units string `json:"units" validate:"-"`
	// 上报模式
	ReportMode ReportMode `json:"reportMode" validate:"required"`
	//数值精度
	Scale float64 `json:"scale"`

	//保留小数位数
	Decimals int `json:"decimals"`
	// 扩展参数
	Extends map[string]interface{} `json:"-" validate:"-"`
}

Point 点位数据

type PointMap

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

func (PointMap) ToPoint

func (pm PointMap) ToPoint() Point

ToPoint 转换为标准点位数据

type ReadPointsAction

type ReadPointsAction struct {
	//设备SN列表
	Devices []string `json:"devices"`
	Points  []string `json:"points"`
}

type ReadWrite

type ReadWrite string

点位读写模式

type ReportMode

type ReportMode string

点位上报模式

type TimerTask

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

TimerTask 定时任务

type ValueType

type ValueType string

点位数据类型