commons

type AlertLevel int

type AppCallBack func(appName string, req AppDriverReq) (Response, error)

type AppDriverReq struct {
	Header  *Header
	Payload []byte
}

type BaseProperty struct {
	Name string `json:"name"` //子设备名
	Ip   string `json:"ip"`   //子设备IP地址
	Lat  string `json:"lat"`  //纬度
	Lon  string `json:"lon"`  //经度
}

type DataType string

type DeviceInfo struct {
	DeviceMeta           // 原始信息
	ActiveStatus  string // 设备激活状态
	OnLineStatus  string // 设备在线/离线状态
	CloudDeviceId string // 设备云端对应的🆔(如果设备已激活)
}

type DeviceMeta struct {
	Cid          string                        `json:"cid"`          //子设备cid，网关下唯一
	ProductId    string                        `json:"productKey"`   //产品id
	BaseAttr     BaseProperty                  `json:"baseAttr"`     //设备属性
	ExtendedAttr ExtendedProperty              `json:"extendedAttr"` //设备属性
	Protocols    map[string]ProtocolProperties `json:"protocols"`    //设备自定义协议配置
}

type DeviceNotifyType string

type DeviceOnlineStatus string

type DeviceStatus struct {
	Online  []string // 设备上线列表
	Offline []string // 设备下线列表
}

type ExtendedProperty struct {
	//VendorCode      string                 `json:"vendorCode"`      //设备厂商
	InstallLocation string                 `json:"installLocation"` //安装地址
	ExtendData      map[string]interface{} `json:"extendData"`      //扩展字段 //map[string]interface{}
}

type GatewayInfo struct {
	GwId        string `json:"gwId"`
	LocalKey    string `json:"localKey"`
	Env         string `json:"env"`
	Region      string `json:"region"`
	Mode        RunningModel
	CloudState  bool   `json:"cloudState"`
	GatewayName string `json:"gatewayName"`
}

type Header struct {
	Tag    string
	From   string
	Option map[string]string
}

type LoggerConfig struct {
	FileName   string
	Prefix     string // service name
	LogLevel   string
	MaxSize    int
	MaxBackups int
	MaxAge     int
	Compress   bool
}

type MqttDriver interface {
	// Auth mqtt设备连接鉴权，broker会将与该驱动相关的mqtt设备连接鉴权信息转发给sdk，sdk会回调该接口，将鉴
	// 权信息发送给驱动应用层做校验，鉴权通过返回true，mqtt broker允许连接，否则拒接连接。
	// clientId：mqtt设备连接时指定的clientID
	// username：mqtt设备连接时指定的username
	// password： mqtt设备连接时指定的password
	Auth(clientId, username, password string) (bool, error)
	// Sub mqtt设备订阅topic校验，broker会将与该驱动相关的mqtt设备订阅topic的信息转发给sdk，sdk会回调该接
	// 口，将topic校验信息发送给驱动应用层做校验，校验通过返回true，mqtt broker允许订阅，否则拒绝订阅。
	// topic：设备要订阅的topic
	// qos：设备要订阅topic的QoS
	Sub(clientId, username, topic string, qos byte) (bool, error)
	// Pub mqtt设备向topic中发布消息前校验，broker会将与该驱动相关的mqtt设备要发布消息的topic的信息转发给
	// sdk，sdk会回调该接口，将topic校验信息发送给驱动应用层做校验，校验通过返回true，mqtt broker允许发布
	// 消息，否则拒绝发布消息
	Pub(clientId, username, topic string, qos byte, retained bool) (bool, error)
	// UnSub mqtt设备取消订阅通知，mqtt设备取消订阅topic后broker会将取消订阅topic的消息通知给对应的驱动
	UnSub(clientId, username string, topics []string)
	// Connected mqtt设备连接成功通知，mqtt设备连接成功后broker会将连接成功消息通知给对应的驱动
	Connected(clientId, username, ip, port string)
	// Closed mqtt设备断开连接后通知，mqtt设备断开连接后broker会将断开连接信息通知给对应的驱动
	Closed(clientId, username string)
}

type Option interface {
	Apply(*Options)
}

type Options struct {
	MqttUsername   string
	MqttDriver     MqttDriver
	ConnHandler    mqtt.OnConnectHandler
	AppService     []string
	AppDataHandler AppCallBack
	EnableRTS      bool
}

type ProductNotifyType string

type ProtocolProperties map[string]interface{}

type ProxyInfo struct {
	Host string `json:"host"`
	Port int    `json:"port"`
}

type RWType string

type Response struct {
	Success bool   `json:"success"`
	Message string `json:"message"`
	Payload []byte `json:"payload"`
}

type RunningModel string

type SubDataType string

type TMDeviceInfo struct {
	TMDeviceMeta `json:",inline"`
	DeviceId     string `json:"deviceId"`     // 设备在云端的IotId
	ActiveStatus string `json:"activeStatus"` // 设备激活状态
	OnLineStatus string `json:"onlineStatus"` // 设备在线/离线状态
}

type TMDeviceMeta struct {
	Cid          string                        `json:"cid"`          //子设备cid，网关下唯一
	ProductId    string                        `json:"productKey"`   //产品pid
	BaseAttr     BaseProperty                  `json:"baseAttr"`     //设备属性
	ExtendedAttr ExtendedProperty              `json:"extendedAttr"` //设备属性
	Protocols    map[string]ProtocolProperties `json:"protocols"`    //设备自定义协议配置
}

type TedgeLogger interface {
	SetLogLevel(level string)
	Debugf(template string, args ...interface{})
	Infof(template string, args ...interface{})
	Warnf(template string, args ...interface{})
	Errorf(template string, args ...interface{})
}