package dm
Get desktop application:
View/edit binary Protocol Buffers messages
service DeviceGroup
dm.proto:267rpc groupInfoCreate (, )
dm.proto:269创建分组
rpc groupInfoMultiCreate (, )
dm.proto:270message
dm.proto:1268repeated groups = 1
rpc groupInfoIndex (, )
dm.proto:273获取分组信息列表
message
dm.proto:1313int64 areaID = 5
分组可以属于某个区域下
optional page = 1
string name = 2
repeated string names = 6
int64 parentID = 3
map<string, string> tags = 4
string purpose = 15
用途 不填默认为default
repeated string purposes = 16
用途
optional hasDevice = 17
message
dm.proto:1325repeated list = 1
int64 total = 2
repeated GroupInfo listAll = 3;
rpc groupInfoRead (, )
dm.proto:275获取分组信息详情
message
dm.proto:1306int64 id = 1
id
bool withChildren = 2
string purpose = 15
用途 不填默认为default
rpc groupInfoUpdate (, )
dm.proto:277更新分组
rpc groupInfoDelete (, )
dm.proto:279删除分组
rpc groupDeviceMultiCreate (, )
dm.proto:281创建分组设备
rpc groupDeviceMultiUpdate (, )
dm.proto:283更新分组设备
rpc groupDeviceMultiDelete (, )
dm.proto:285删除分组设备
message
dm.proto:1349int64 groupID = 1
string purpose = 2
用途 不填默认为default
repeated list = 3
service DeviceInteract
dm.proto:323设备交互
rpc actionSend (, )
dm.proto:325调用设备行为
message
dm.proto:1047string productID = 1
产品id 获取产品id下的所有设备信息
string deviceName = 2
设备名
string actionID = 3
产品数据模板中行为功能的标识符，由开发者自行根据设备的应用场景定义
string inputParams = 4
输入参数
bool isAsync = 5
是否异步获取
optional option = 6
异步选项
rpc actionRead (, )
dm.proto:327获取异步调用设备行为的结果
rpc actionResp (, )
dm.proto:330回复调用设备行为
message
dm.proto:1087string productID = 1
产品id 获取产品id下的所有设备信息
string deviceName = 2
设备名
string msgToken = 3
调用id
string outputParams = 4
输出参数 注意：此字段可能返回 null，表示取不到有效值。
string msg = 5
返回状态
int64 code = 6
设备返回状态码
rpc propertyGetReportSend (, )
dm.proto:333请求设备获取设备最新属性
message
dm.proto:769string productID = 1
产品id (必填)
string deviceName = 2
设备名(必填)
repeated string dataIDs = 3
获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条
message
dm.proto:775int64 code = 1
设备返回状态码
string msg = 2
返回状态
string msgToken = 3
调用id
int64 timestamp = 4
上报时间戳(毫秒时间戳)
string params = 5
获取到的值
请求设备获取设备最新属性
message
dm.proto:795repeated string dataIDs = 1
获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条
string productID = 2
产品id
repeated string deviceNames = 3
设备名
repeated devices = 4
如果是不同的产品,则传这个字段,上面两个参数填了优先使用
int64 areaID = 5
控制一个区域的设备
string areaIDPath = 6
根据区域路径控制设备
int64 groupID = 7
控制一个组的设备
message
dm.proto:805repeated list = 1
批量设备返回结果列表
rpc propertyControlSend (, )
dm.proto:338调用设备属性
message
dm.proto:1070string productID = 1
产品id
string deviceName = 2
设备名
string data = 3
属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义
int64 shadowControl = 4
设备影子控制 0:自动,当设备不在线的时候设置设备影子,设备在线时直接下发给设备 1:只实时下发,不在线报错 2:如果有设备影子只修改影子,没有的也不下发 3: 只修改云端的值,不下发设备
bool isAsync = 6
是否异步操作 异步情况通过获取接口来获取
optional withProfile = 7
int64 syncTimeout = 8
同步超时时间(单位:秒)
rpc propertyControlMultiSend (, )
dm.proto:340批量调用设备属性
message
dm.proto:1137string productID = 1
产品id
repeated string deviceNames = 2
设备名
repeated devices = 3
如果是不同的产品,则传这个字段,上面两个参数填了优先使用
int64 shadowControl = 4
设备影子控制 0:自动,当设备不在线的时候设置设备影子,设备在线时直接下发给设备 1:只实时下发,不在线报错 2:如果有设备影子只修改影子,没有的也不下发
string data = 5
属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义
bool isAsync = 6
是否异步操作 异步情况通过获取接口来获取
int64 areaID = 7
控制一个区域的设备
string areaIDPath = 10
根据区域路径控制设备
int64 groupID = 8
控制一个组的设备
int64 syncTimeout = 9
同步超时时间(单位:秒,不填默认3秒)
message
dm.proto:1160repeated list = 1
批量设备返回结果列表
rpc propertyControlRead (, )
dm.proto:342获取异步调用设备属性的结果
rpc sendMsg (, )
dm.proto:344发送消息给设备 -- 调试使用
message
dm.proto:1126string topic = 1
发送的topic
bytes payload = 2
发送的数据
message
dm.proto:1131(message has no fields)
rpc gatewayGetFoundSend (, )
dm.proto:346获取网关拓扑关系
message
dm.proto:1103string productID = 1
产品id
string deviceName = 2
设备名
rpc gatewayNotifyBindSend (, )
dm.proto:348通知网关绑定子设备
message
dm.proto:1121optional gateway = 1
repeated subDevices = 2
rpc edgeSend (, )
dm.proto:351提供给边缘端进行http访问
message
dm.proto:1108string handle = 1
对应 mqtt topic的第一个 thing ota config 等等
string type = 2
操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为
bytes payload = 3
string productID = 4
string deviceName = 5
message
dm.proto:1117bytes payload = 3
service DeviceManage
dm.proto:83设备管理
rpc rootCheck (, )
dm.proto:85鉴定是否是root账号(提供给mqtt broker)
message
dm.proto:1616string username = 1
用户名
string password = 2
密码
string clientID = 3
clientID
string ip = 4
访问的ip地址
bytes certificate = 5
客户端证书
rpc deviceInfoCreate (, )
dm.proto:87新增设备
rpc deviceInfoUpdate (, )
dm.proto:89更新设备
rpc deviceOnlineMultiFix (, )
dm.proto:90message
dm.proto:1502repeated devices = 1
rpc deviceInfoDelete (, )
dm.proto:92删除设备
message
dm.proto:1512string productID = 1
产品id
string deviceName = 2
设备名称
rpc deviceInfoIndex (, )
dm.proto:94获取设备信息列表
message
dm.proto:1550optional page = 1
分页信息 只获取一个则不填
string productID = 2
过滤条件: 产品id
repeated string productIDs = 23
过滤条件: 产品id
string deviceName = 3
过滤条件:模糊查询 设备名
repeated string deviceNames = 4
过滤条件:精准查询 设备名
map<string, string> tags = 5
key tag过滤查询,非模糊查询 为tag的名,value为tag对应的值
map<string, string> tagsLike = 46
key tag过滤查询,模糊查询 为tag的名,value为tag对应的值
int64 range = 6
过滤条件:取距离坐标点固定范围内的设备
optional Position = 7
设备定位,默认百度坐标系
repeated int64 areaIDs = 8
区域ids
string areaIDPath = 32
区域路径过滤
string deviceAlias = 9
过滤条件:模糊查询 设备别名
int64 isOnline = 10
在线状态过滤 1离线 2在线
int64 productCategoryID = 11
产品品类id
repeated int64 productCategoryIDs = 33
产品品类id
repeated devices = 12
int64 withShared = 13
过滤分享的设备(这里只获取分享的设备) 1: 同时获取分享的设备 2:只获取分享的设备
int64 withCollect = 24
过滤收藏的设备(这里只获取收藏的设备) 1: 同时获取收藏的设备 2:只获取收藏的设备
int64 netType = 25
通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN
string tenantCode = 14
租户过滤
repeated string versions = 15
版本列表
string notVersion = 39
非版本
int64 deviceType = 16
过滤设备类型:0:全部,1:设备,2:网关,3:子设备
repeated int64 deviceTypes = 21
optional gateway = 17
获取网关下子设备列表
int64 groupID = 18
int64 notGroupID = 19
int64 parentGroupID = 42
string groupPurpose = 45
设备分组用途 不填默认为default
string groupName = 43
模糊查询
int64 notAreaID = 29
optional distributor = 20
过滤分销商的数据
int64 status = 22
repeated int64 statuses = 35
optional ratedPower = 28
额定功率:单位w/h
int64 hasOwner = 30
是否被人拥有
int64 userID = 31
用户id查询
optional expTime = 38
到期时间
string iccid = 40
SIM卡卡号
bool withGateway = 41
同时返回子设备的网关
string protocolCode = 51
协议查询
optional rssi = 52
optional dept = 53
过滤分销商的数据
message
dm.proto:1596repeated list = 1
设备信息
int64 total = 2
总数(只有分页的时候会返回)
rpc DeviceInfoMultiUpdate (, )
dm.proto:96批量更新设备状态
message
dm.proto:1541repeated devices = 1
产品id
optional FilterDistributorID = 2
int64 areaID = 4
项目区域id
optional distributor = 20
分销商的数据
int64 ratedPower = 28
额定功率:单位w/h
rpc deviceInfoRead (, )
dm.proto:98获取设备信息详情
message
dm.proto:1535string productID = 1
产品id
string deviceName = 2
设备名称
bool withGateway = 3
同时返回子设备的网关
rpc deviceInfoBind (, )
dm.proto:99message
dm.proto:1895optional device = 1
int64 areaID = 2
string token = 3
中绑定的token
rpc deviceBindTokenRead (, )
dm.proto:100message
dm.proto:1887string token = 1
配网token
rpc deviceBindTokenCreate (, )
dm.proto:101rpc deviceInfoMultiBind (, )
dm.proto:102批量绑定
message
dm.proto:1860repeated devices = 1
int64 areaID = 2
message
dm.proto:1867repeated errs = 1
rpc deviceInfoCanBind (, )
dm.proto:103message
dm.proto:1856optional device = 1
rpc deviceInfoUnbind (, )
dm.proto:104message
dm.proto:1871string productID = 1
产品id
string deviceName = 2
设备名称
string secretType = 3
中绑定,强制解绑参数 对参数（deviceName、nonce、productID、timestamp）按字典序升序排序。 将以上参数，按参数名称 = 参数值 & 参数名称 = 参数值拼接成字符串, 如："deviceName=xxx&nonce=2125656451&productID=xxx×tamp=1687525491"。 使用 HMAC-sha1 算法对上一步中获得的字符串进行计算，密钥取secretType 取设备的物模型密码类型的属性。 将生成的结果使用 Base64 进行编码，即可获得最终的签名串放入 signature。
采用秘钥的类型
string signature = 4
签名
int64 timestamp = 5
秒时间戳
string signType = 6
hmacsha256 hmacsha1 hmacmd5(默认)
int64 nonce = 7
随机数
rpc deviceTransfer (, )
dm.proto:105rpc deviceReset (, )
dm.proto:106设备重置
message
dm.proto:483optional device = 1
设备信息
bool log = 2
日志清除
bool deviceSchema = 3
设备物模型定义清除
bool bind = 4
绑定关系解绑
bool info = 5
设备信息恢复出厂设置,包含过期时间,名称,设备配置等
rpc deviceMove (, )
dm.proto:107将设备信息迁移到新的设备中
message
dm.proto:477optional old = 1
需要转移的设备
optional new = 2
转移的对象
repeated string withTarget = 3
设备配置-profile,schemaAlias:profile
rpc deviceModuleVersionRead (, )
dm.proto:109message
dm.proto:451int64 id = 1
填id或者以下三个参数
string productID = 2
string deviceName = 3
string moduleCode = 4
rpc deviceModuleVersionIndex (, )
dm.proto:110message
dm.proto:465optional page = 1
string productID = 2
string deviceName = 3
string moduleCode = 4
message
dm.proto:472int64 total = 1
repeated list = 2
rpc deviceGatewayMultiCreate (, )
dm.proto:113绑定网关下子设备设备
message
dm.proto:1235optional gateway = 1
bool isNotNotify = 2
不通知网关设备状态做了调整
bool isAuthSign = 3
是否校验设备签名
repeated list = 4
rpc deviceGatewayMultiUpdate (, )
dm.proto:115绑定网关下子设备设备
rpc deviceGatewayIndex (, )
dm.proto:117获取绑定信息的设备信息列表
message
dm.proto:1243optional page = 1
optional gateway = 2
获取网关下子设备列表
optional subDevice = 3
获取子设备绑定的网关列表
message
dm.proto:1249repeated list = 1
int64 total = 2
rpc deviceGatewayMultiDelete (, )
dm.proto:119删除网关下子设备
rpc deviceInfoCount (, )
dm.proto:121设备计数
message
dm.proto:1925optional timeRange = 1
repeated int64 areaIDs = 2
repeated int64 groupIDs = 3
message
dm.proto:1937int64 online = 1
int64 offline = 2
int64 inactive = 3
int64 unknown = 4
int64 total = 5
rpc deviceTypeCount (, )
dm.proto:123设备类型
message
dm.proto:1931optional timeRange = 1
repeated int64 areaIDs = 2
repeated int64 groupIDs = 3
message
dm.proto:1945int64 device = 1
int64 gateway = 2
int64 subset = 3
int64 unknown = 4
rpc deviceCount (, )
dm.proto:125message
dm.proto:1910repeated string countTypes = 1
在线设备数:status,设备类型: deviceType
int64 rangeType = 2
0:全部 1:area 2:group
repeated int64 rangeIDs = 3
//统计的id列表, areaID或者groupID
message
dm.proto:1916repeated list = 1
rpc deviceProfileRead (, )
dm.proto:127rpc deviceProfileDelete (, )
dm.proto:128rpc deviceProfileUpdate (, )
dm.proto:129rpc deviceProfileIndex (, )
dm.proto:130message
dm.proto:1901optional device = 1
repeated string codes = 2
message
dm.proto:1906repeated profiles = 1
rpc deviceSchemaUpdate (, )
dm.proto:134更新设备物模型
rpc deviceSchemaCreate (, )
dm.proto:136新增设备
rpc deviceSchemaMultiCreate (, )
dm.proto:138批量新增物模型,只新增没有的,已有的不处理
message
dm.proto:1767string productID = 1
string deviceName = 3
repeated list = 2
物模型信息
rpc deviceSchemaMultiDelete (, )
dm.proto:140删除设备物模型
message
dm.proto:1775string productID = 1
产品id 如果为空返回所有产品的信息
string deviceName = 3
repeated string identifiers = 2
标识符
rpc deviceSchemaIndex (, )
dm.proto:142获取设备物模型列表
message
dm.proto:1781optional page = 1
分页信息 只获取一个则不填
string productID = 2
产品id 必填
string deviceName = 19
int64 type = 3
物模型类型 1:property属性 2:event事件 3:action行为
repeated int64 types = 17
int64 tag = 4
过滤条件: 物模型标签 1:自定义 2:可选 3:必选
repeated string identifiers = 5
过滤标识符列表
string name = 6
标识符名字过滤
int64 isCanSceneLinkage = 8
是否支持场景联动控制
int64 funcGroup = 14
功能分类: 1:普通功能 2:系统功能
int64 userPerm = 15
用户权限操作: 1:r(只读) 3:rw(可读可写)
string propertyMode = 16
属性类型可用 读写类型: 1:r(只读) 2:rw(可读可写)
int64 controlMode = 18
控制模式: 1: 可以群控,可以单控 2:只能单控
bool withProductSchema = 20
同时获取产品物模型
message
dm.proto:1798repeated list = 1
int64 total = 2
总数(只有分页的时候会返回)
rpc deviceSchemaTslRead (, )
dm.proto:143message
dm.proto:1823string productID = 1
产品id
string deviceName = 17
设备ID 必填
bool withProductSchema = 20
同时获取产品物模型
message
dm.proto:1829string tsl = 1
物模型tsl
rpc deviceGroupMultiCreate (, )
dm.proto:147将设备加到多个分组中
rpc deviceGroupMultiUpdate (, )
dm.proto:149更新设备所在分组
rpc deviceGroupMultiDelete (, )
dm.proto:151删除设备所在分组
service DeviceMsg
dm.proto:296设备消息
rpc sdkLogIndex (, )
dm.proto:298获取设备sdk调试日志
message
dm.proto:1027获取sdk调试日志信息
string productID = 1
产品id
string deviceName = 2
设备名
int64 timeStart = 3
获取时间的开始
int64 timeEnd = 4
时间的结束
int64 logLevel = 5
日志等级
optional page = 6
分页信息 只获取一个则不填
message
dm.proto:1036sdk调试日志信息
int64 total = 1
总数
repeated list = 2
rpc hubLogIndex (, )
dm.proto:300获取设备调试信息记录登入登出,操作
message
dm.proto:890实时获取对应信息
string productID = 1
产品id
string deviceName = 2
设备名
int64 timeStart = 3
获取时间的开始(毫秒时间戳)
int64 timeEnd = 4
时间的结束(毫秒时间戳)
optional page = 5
分页信息
repeated string actions = 6
过滤操作类型 connected:上线 disconnected:下线 property:属性 event:事件 action:操作 thing:物模型提交的操作为匹配的日志
repeated string topics = 7
过滤主题
string content = 8
过滤内容
string requestID = 9
过滤请求ID
message
dm.proto:903实时获取对应信息
int64 total = 1
总数
repeated list = 2
rpc sendLogIndex (, )
dm.proto:301message
dm.proto:952实时获取对应信息
int64 projectID = 13
只有管理员有权限
int64 areaID = 14
只有管理员有权限
string areaIDPath = 15
只有管理员有权限
repeated int64 areaIDs = 16
只有管理员有权限
int64 productCategoryID = 11
产品品类id
string productID = 1
产品id
string deviceName = 2
设备名
int64 timeStart = 3
获取时间的开始(毫秒时间戳)
int64 timeEnd = 4
时间的结束(毫秒时间戳)
optional page = 5
分页信息
int64 userID = 9
repeated string actions = 10
int64 resultCode = 12
请求结果状态,200为成功
string dataID = 8
identify
repeated string dataIDs = 7
message
dm.proto:971实时获取对应信息
int64 total = 1
总数
repeated list = 2
rpc statusLogIndex (, )
dm.proto:302message
dm.proto:925实时获取对应信息
string productID = 1
产品id
string deviceName = 2
设备名
int64 timeStart = 3
获取时间的开始(毫秒时间戳)
int64 timeEnd = 4
时间的结束(毫秒时间戳)
optional page = 5
分页信息
int64 status = 9
在线状态
message
dm.proto:935实时获取对应信息
int64 total = 1
总数
repeated list = 2
rpc abnormalLogIndex (, )
dm.proto:304message
dm.proto:992实时获取对应信息
int64 projectID = 13
只有管理员有权限
int64 areaID = 14
只有管理员有权限
string areaIDPath = 15
只有管理员有权限
repeated int64 areaIDs = 16
只有管理员有权限
int64 productCategoryID = 17
产品品类id
string productID = 1
产品id
string deviceName = 2
设备名
int64 timeStart = 3
获取时间的开始(毫秒时间戳)
int64 timeEnd = 4
时间的结束(毫秒时间戳)
optional page = 5
分页信息
int64 userID = 9
int64 action = 10
string type = 11
异常类型
int64 resultCode = 12
请求结果状态,200为成功
message
dm.proto:1010实时获取对应信息
int64 total = 1
总数
repeated list = 2
rpc abnormalLogCreate (, )
dm.proto:305rpc propertyLogLatestIndex (, )
dm.proto:308获取设备数据信息
rpc propertyLogLatestIndex2 (, )
dm.proto:309message
dm.proto:843repeated devices = 4
rpc propertyLogIndex (, )
dm.proto:312获取设备数据信息
message
dm.proto:810获取对应日志信息
optional page = 1
使用了聚合函数及间隔的时候无效
string deviceName = 2
设备ID
repeated string deviceNames = 3
string productID = 4
产品id (必填)
string dataID = 5
获取的具体标识符的数据(必填)
int64 timeStart = 6
获取时间的开始(毫秒时间戳)
int64 timeEnd = 7
时间的结束(毫秒时间戳)
int64 interval = 8
间隔 如果这个值不为零值 则时间的开始和结束必须有效及聚合函数不应该为空
string intervalUnit = 12
间隔单位 a (毫秒,默认), d (天), h (小时), m (分钟), n (月), s (秒), u (微秒), w (周), y (年)
string argFunc = 9
聚合函数 avg:平均值 first:第一个参数 last:最后一个参数 count:总数 twa: 时间加权平均函数 参考:https://docs.taosdata.com/reference/taos-sql/function
string fill = 10
/* FILL 语句指定某一窗口区间数据缺失的情况下的填充模式。填充模式包括以下几种： 不进行填充：NONE（默认填充模式）。 VALUE 填充：固定值填充，此时需要指定填充的数值。例如：FILL(VALUE, 1.23)。 PREV 填充：使用前一个非 NULL 值填充数据。例如：FILL(PREV)。 NULL 填充：使用 NULL 填充数据。例如：FILL(NULL)。 LINEAR 填充：根据前后距离最近的非 NULL 值做线性插值填充。例如：FILL(LINEAR)。 NEXT 填充：使用下一个非 NULL 值填充数据。例如：FILL(NEXT)。 */
填充模式 参考:https://docs.taosdata.com/reference/taos-sql/distinguished/#fill-%E5%AD%90%E5%8F%A5
int64 order = 11
时间排序 0:aes(默认,从久到近排序) 1:desc(时间从近到久排序)
string partitionBy = 13
切分数据,可以填写deviceName
int64 productCategoryID = 14
产品品类id,通用物模型有效
rpc eventLogIndex (, )
dm.proto:314获取设备数据信息
message
dm.proto:863获取对应日志信息
optional page = 1
使用了聚合函数及间隔的时候无效
string productID = 2
产品id (必填)
string deviceName = 3
设备名(不填获取产品下所有设备)
repeated string deviceNames = 8
废弃
string dataID = 4
获取的具体标识符的数据(必填)
int64 timeStart = 5
获取时间的开始(毫秒时间戳)
int64 timeEnd = 6
时间的结束(毫秒时间戳)
repeated string types = 7
类型 事件类型: 信息:info 告警alert 故障:fault
message
dm.proto:884获取对应日志信息
int64 total = 1
总数
repeated list = 2
rpc shadowIndex (, )
dm.proto:316获取设备影子列表
message
dm.proto:759repeated list = 1
rpc gatewayCanBindIndex (, )
dm.proto:319获取网关可以绑定的子设备列表
message
dm.proto:1259optional gateway = 1
message
dm.proto:1263repeated subDevices = 1
int64 updatedTime = 2
更新时间
service OtaManage
dm.proto:355新的ota功能实现
rpc otaFirmwareInfoCreate (, )
dm.proto:357添加升级包
message
dm.proto:2075string productID = 2
产品id
string name = 3
固件升级包名称
string version = 4
* 当前OTA升级包的版本号，仅支持英文字母、数字、半角句号（.）、短划线（-）和下划线（_）。长度限制为1~64个字符。
版本号
string signMethod = 6
* OTA升级包签名方法。取值： MD5（默认）：MD5签名。 SHA256：SHA256签名。
签名方法
string desc = 9
文件描述
int64 isDiff = 10
* OTA升级包类型。可选： 0：整包升级包，您上传的升级包文件包含完整的升级包，将推送整包升级包给设备进行升级。 1：差分升级包，您上传的升级包文件仅包含新版本升级包与之前版本的差异部分，仅推送差异部分给设备进行升级。 不传入此参数，则默认值为0。
升级包类型
string srcVersion = 12
int64 isNeedToVerify = 13
是否需要验证
optional extra = 14
自定义数据
repeated string filePaths = 15
string moduleCode = 16
模块编码
rpc otaFirmwareInfoUpdate (, )
dm.proto:359修改升级包
message
dm.proto:2104int64 id = 1
固件id
string name = 2
固件升级包名称
string desc = 3
文件描述
optional extra = 14
推送设备端的信息
rpc otaFirmwareInfoDelete (, )
dm.proto:361删除升级包
rpc otaFirmwareInfoIndex (, )
dm.proto:363升级包列表
message
dm.proto:2113optional page = 1
分页
string productID = 2
产品id
string name = 3
产品名称
message
dm.proto:2119repeated list = 1
int64 total = 2
rpc otaFirmwareInfoRead (, )
dm.proto:365查询升级包
rpc otaFirmwareJobCreate (, )
dm.proto:369创建静态升级批次
rpc otaFirmwareJobIndex (, )
dm.proto:371获取升级包下的升级任务批次列表
message
dm.proto:2234optional page = 1
int64 firmwareID = 2
string productID = 3
string deviceName = 4
message
dm.proto:2241repeated list = 1
int64 total = 2
rpc otaFirmwareJobRead (, )
dm.proto:373查询指定升级批次的详情
rpc otaFirmwareJobUpdate (, )
dm.proto:375取消动态升级策略
rpc otaFirmwareDeviceIndex (, )
dm.proto:377查询指定升级批次下的设备升级作业列表
message
dm.proto:2254optional page = 1
int64 firmwareID = 2
int64 jobID = 3
string deviceName = 4
string srcVersion = 7
int64 status = 11
设备升级作业状态。1：待确认。 2：待推送。 3：已推送。 4：升级中。 5:升级成功 6: 升级失败. 7:已取消
int64 isOnline = 15
设备是否在线
message
dm.proto:2279repeated list = 1
int64 total = 2
rpc otaFirmwareDeviceCancel (, )
dm.proto:379取消指定批次下的设备升级作业
message
dm.proto:2284int64 firmwareID = 1
int64 jobID = 2
repeated string deviceNames = 3
rpc otaFirmwareDeviceRetry (, )
dm.proto:381重新升级指定批次下升级失败或升级取消的设备升级作业
message
dm.proto:2291int64 firmwareID = 1
int64 jobID = 2
repeated string deviceNames = 3
rpc otaFirmwareDeviceConfirm (, )
dm.proto:383app确认设备升级
message
dm.proto:2297string productID = 1
string deviceName = 2
rpc otaModuleInfoCreate (, )
dm.proto:386rpc otaModuleInfoUpdate (, )
dm.proto:387rpc otaModuleInfoDelete (, )
dm.proto:388rpc otaModuleInfoIndex (, )
dm.proto:389message
dm.proto:425optional page = 1
string name = 2
string productID = 3
message
dm.proto:431int64 total = 1
repeated list = 2
rpc otaModuleInfoRead (, )
dm.proto:390
service ProductManage
dm.proto:155产品管理
rpc productInit (, )
dm.proto:156产品管理
message
dm.proto:446repeated string productIDs = 2
repeated string initType =1;//thing:物模型
产品id,不填初始化所有产品
rpc productInfoCreate (, )
dm.proto:159新增产品
rpc productInfoUpdate (, )
dm.proto:161更新产品
rpc productInfoDelete (, )
dm.proto:163删除产品
message
dm.proto:1463string productID = 1
产品id
rpc productInfoIndex (, )
dm.proto:165获取产品信息列表
message
dm.proto:1473optional page = 1
分页信息 只获取一个则不填
int64 deviceType = 2
过滤设备类型:0:全部,1:设备,2:网关,3:子设备
repeated int64 deviceTypes = 10
string productName = 3
过滤条件: 产品名称
repeated string productIDs = 4
过滤产品id列表
map<string, string> tags = 5
key tag过滤查询,非模糊查询 为tag的名,value为tag对应的值
map<string, string> protocolConf = 6
协议配置查询
string protocolCode = 7
string protocolType = 25
协议类型
string protocolTrans = 26
传输层协议类型
bool withProtocol = 8
bool withCategory = 9
string sceneMode = 16
场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景)
repeated string sceneModes = 17
场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景)
int64 status = 20
产品状态 1:启用 2:禁用 3:开发中
repeated int64 statuses = 21
产品状态 1:启用 2:禁用 3:开发中
int64 netType = 11
通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN
int64 projectID = 12
项目id,只获取项目下有设备的
int64 areaID = 22
区域下有设备的产品列表
string areaIDPath = 24
区域路径过滤
repeated int64 categoryIDs = 23
产品品类
message
dm.proto:1497repeated list = 1
产品信息
int64 total = 2
总数(只有分页的时候会返回)
rpc productInfoRead (, )
dm.proto:167获取产品信息详情
message
dm.proto:1467string productID = 1
产品id
bool withProtocol = 2
bool withCategory = 3
rpc productConfigUpdate (, )
dm.proto:169更新产品配置
物模型管理
rpc productSchemaUpdate (, )
dm.proto:172更新产品物模型
message
dm.proto:1688optional info = 1
物模型信息
rpc productSchemaCreate (, )
dm.proto:174新增产品
message
dm.proto:1698optional info = 1
物模型信息
rpc productSchemaMultiCreate (, )
dm.proto:176批量新增物模型,只新增没有的,已有的不处理
message
dm.proto:1693string productID = 1
repeated list = 2
物模型信息
rpc productSchemaDelete (, )
dm.proto:178删除产品
message
dm.proto:1702string productID = 1
产品id 如果为空返回所有产品的信息
string identifier = 2
标识符
rpc productSchemaIndex (, )
dm.proto:180获取产品信息列表
message
dm.proto:1708optional page = 1
分页信息 只获取一个则不填
string productID = 2
产品id 必填
int64 type = 3
物模型类型 1:property属性 2:event事件 3:action行为
repeated int64 types = 17
int64 tag = 4
过滤条件: 物模型标签 1:自定义 2:可选 3:必选
repeated string identifiers = 5
过滤标识符列表
string name = 6
标识符名字过滤
int64 isCanSceneLinkage = 8
是否支持场景联动控制
int64 funcGroup = 14
功能分类: 1:普通功能 2:系统功能
int64 userPerm = 15
用户权限操作: 1:r(只读) 3:rw(可读可写)
string propertyMode = 16
属性类型可用 读写类型: 1:r(只读) 2:rw(可读可写)
int64 controlMode = 18
控制模式: 1: 可以群控,可以单控 2:只能单控
message
dm.proto:1724repeated list = 1
int64 total = 2
总数(只有分页的时候会返回)
rpc productSchemaTslImport (, )
dm.proto:182删除产品
message
dm.proto:1750string productID = 1
产品id
string tsl = 2
物模型tsl
rpc productSchemaTslRead (, )
dm.proto:184获取产品信息列表
message
dm.proto:1755string productID = 1
产品id
message
dm.proto:1759string tsl = 1
物模型tsl
rpc productCustomRead (, )
dm.proto:187脚本管理
message
dm.proto:1200string productID = 1
rpc productCustomUpdate (, )
dm.proto:188rpc productCategoryCreate (, )
dm.proto:193新增产品
rpc productCategoryUpdate (, )
dm.proto:195更新产品
rpc productCategoryDelete (, )
dm.proto:197删除产品
rpc productCategoryIndex (, )
dm.proto:199获取产品信息列表
message
dm.proto:604optional page = 1
分页信息 只获取一个则不填
string name = 2
过滤名字
int64 parentID = 3
repeated int64 ids = 4
int64 projectID = 5
项目id,只获取项目下有设备的
message
dm.proto:612repeated list = 1
产品信息
int64 total = 2
总数(只有分页的时候会返回)
rpc productCategoryRead (, )
dm.proto:201获取产品信息详情
message
dm.proto:53int64 id = 1
id
bool withChildren = 2
获取产品品类下的物模型列表,绑定的物模型会自动添加到该产品品类及子分类的产品中,并不支持删除
message
dm.proto:594int64 productCategoryID = 1
bool withFather = 8
同时返回父节点的物模型
message
dm.proto:590repeated string identifiers = 5
过滤标识符列表
service ProtocolManage
dm.proto:224rpc protocolInfoIndex (, )
dm.proto:226协议列表
message
dm.proto:692optional page = 1
string name = 2
string code = 3
iThings,iThings-thingsboard,wumei,aliyun,huaweiyun,tuya
string type = 4
协议类型
string transProtocol = 5
传输协议: mqtt,tcp,udp
repeated string notCodes = 6
排除的协议包
repeated string codes = 7
message
dm.proto:702repeated list = 1
int64 total = 2
rpc protocolInfoRead (, )
dm.proto:228协议详情
rpc protocolInfoCreate (, )
dm.proto:230协议创建
rpc protocolInfoUpdate (, )
dm.proto:232协议更新
rpc protocolInfoDelete (, )
dm.proto:234协议删除
rpc protocolServiceUpdate (, )
dm.proto:237更新服务状态,只给服务调用
rpc protocolServiceDelete (, )
dm.proto:238rpc protocolServiceIndex (, )
dm.proto:239message
dm.proto:707optional page = 1
string code = 2
iThings,iThings-thingsboard,wumei,aliyun,huaweiyun,tuya
message
dm.proto:712repeated list = 1
int64 total = 2
rpc ProtocolScriptIndex (, )
dm.proto:242协议列表
message
dm.proto:643optional page = 1
string name = 2
int64 triggerDir = 3
1:up 2:down
int64 triggerTimer = 4
收到前处理1:before 2:after
string triggerHandle = 5
string triggerType = 6
int64 status = 7
状态:是否启用
message
dm.proto:654repeated list = 1
int64 total = 2
rpc ProtocolScriptRead (, )
dm.proto:244协议详情
rpc ProtocolScriptCreate (, )
dm.proto:246协议创建
rpc ProtocolScriptUpdate (, )
dm.proto:248协议更新
rpc ProtocolScriptDelete (, )
dm.proto:250协议删除
rpc ProtocolScriptDebug (, )
dm.proto:252message
dm.proto:617int64 triggerDir = 2
1:up 2:down
int64 triggerTimer = 3
收到前处理1:before 2:after
string script = 6
脚本内容
optional req = 8
请求
optional resp = 9
回复
message
dm.proto:625optional out = 1
repeated string logs = 2
协议列表
message
dm.proto:674optional page = 1
int64 triggerSrc = 2
product:1 device:2
string productID = 3
string deviceName = 4
int64 status = 5
状态:是否启用
int64 scriptID = 6
脚本对应的ID
bool withDevice = 7
同时返回产品或设备信息
bool withScript = 8
同时返回脚本信息
message
dm.proto:686repeated list = 1
int64 total = 2
rpc ProtocolScriptDeviceRead (, )
dm.proto:258协议详情
协议创建
协议更新
协议删除
service RemoteConfig
dm.proto:288rpc RemoteConfigCreate (, )
dm.proto:289message
dm.proto:1173string productID = 1
string content = 2
rpc RemoteConfigIndex (, )
dm.proto:290message
dm.proto:1178optional page = 1
string productID = 2
message
dm.proto:1183repeated list = 1
int64 total = 2
rpc RemoteConfigPushAll (, )
dm.proto:291message
dm.proto:1188string productID = 1
rpc RemoteConfigLastRead (, )
dm.proto:292message
dm.proto:1192string productID = 1
message
dm.proto:1196optional info = 1
service SchemaManage
dm.proto:211公共物模型管理
rpc commonSchemaInit (, )
dm.proto:212rpc commonSchemaUpdate (, )
dm.proto:214更新产品物模型
message
dm.proto:1624optional info = 1
物模型信息
rpc commonSchemaCreate (, )
dm.proto:216新增产品
message
dm.proto:1631optional info = 1
物模型信息
rpc commonSchemaDelete (, )
dm.proto:218删除产品
rpc commonSchemaIndex (, )
dm.proto:220获取产品信息列表
message
dm.proto:1637optional page = 1
分页信息 只获取一个则不填
repeated string productIDs = 2
有这个属性的产品id列表
int64 type = 3
物模型类型 1:property属性 2:event事件 3:action行为
repeated int64 types = 20
repeated string identifiers = 5
过滤标识符列表
string name = 6
标识符名字过滤
bool withProductCategory = 4
int64 productCategoryID = 7
过滤属于该产品品类的物模型
bool productCategoryWithFather = 8
同时返回父节点的物模型
int64 isCanSceneLinkage = 9
是否支持场景联动控制
int64 funcGroup = 14
功能分类: 1:普通功能 2:系统功能
int64 userPerm = 15
用户权限操作: 1:r(只读) 3:rw(可读可写)
int64 areaID = 16
过滤区域下设备共有的物模型
string areaIDPath = 23
区域路径过滤
int64 projectID = 24
过滤项目下设备共有的物模型
int64 groupID = 17
过滤分组下设备共有的物模型
repeated int64 groupIDs = 18
过滤分组下设备共有的物模型
string propertyMode = 19
属性类型可用 读写类型: 1:r(只读) 2:rw(可读可写)
int64 controlMode = 21
控制模式: 1: 可以群控,可以单控 2:只能单控
string productSceneMode = 22
产品场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景)
message
dm.proto:1660repeated list = 1
int64 total = 2
总数(只有分页的时候会返回)
service userDevice
dm.proto:394用户收藏的设备
rpc userDeviceCollectIndex (, )
dm.proto:398rpc userDeviceShareCreate (, )
dm.proto:401分享设备
rpc userDeviceShareUpdate (, )
dm.proto:403更新权限
rpc userDeviceShareDelete (, )
dm.proto:405取消分享设备
取消分享设备
message
dm.proto:518repeated int64 ids = 1
int64 projectID = 2
指定项目的情况下删除分享的所有设备
rpc userDeviceShareIndex (, )
dm.proto:409获取设备分享列表(只有设备的所有者才能获取)
message
dm.proto:507optional page = 1
optional device = 2
设备信息
message
dm.proto:512repeated list = 1
int64 total = 2
rpc userDeviceShareRead (, )
dm.proto:411获取设备分享的详情
rpc userDeviceTransfer (, )
dm.proto:414转让设备
rpc userDeviceOtaGetVersion(UserDeviceOtaGetVersionReq)returns(userDeviceOtaGetVersionResp); 创建批量分享二维码，设备列表写入缓存
扫码后获取设备列表
接受批量分享的设备
message
dm.proto:563string shareToken = 1
int64 sharedUserID = 3
分享的对象
string sharedUserAccount = 2
分享的账号(只读)
repeated devices = 4
message
dm.proto:1016设备的日志数据
Used as request type in: DeviceMsg.abnormalLogCreate
Used as field type in:
int64 timestamp = 1
发生时间戳(毫秒时间戳)
int64 action = 2
触发1还是解除2
string type = 4
异常类型
string productID = 5
string deviceName = 6
string Reason = 7
原因
string traceID = 9
服务器端事务id
message
dm.proto:1056Used as response type in: DeviceInteract.actionRead, DeviceInteract.actionSend
string msgToken = 1
调用id
string outputParams = 2
输出参数 注意：此字段可能返回 null，表示取不到有效值。
string msg = 3
返回状态
int64 code = 4
设备返回状态码
message
dm.proto:1666Used in: , ,
int64 id = 1
int64 type = 2
物模型类型 1:property属性 2:event事件 3:action行为
string identifier = 4
标识符
optional name = 5
功能名称
optional desc = 6
描述
int64 required = 7
是否必须 1:是 2:否
int64 isCanSceneLinkage = 8
是否支持场景联动控制
int64 funcGroup = 14
功能分类: 1:普通功能 2:系统功能
int64 userPerm = 15
用户权限操作: 1:r(只读) 3:rw(可读可写)
int64 isHistory = 10
是否存储历史记录
int64 isPassword = 17
是否是密码类型,密码类型需要加掩码
optional affordance = 11
各功能类型的详细参数定义
string extendConfig = 12
拓展参数
int64 order = 13
排序
int64 controlMode = 16
控制模式: 1: 可以群控,可以单控 2:只能单控
repeated productCategories = 3
绑定的产品品类(如果绑定了,则该品类下的产品会自动新增并不允许删除)
message
dm.proto:34Used in: ,
string CmpType = 1
"=":相等 "!=":不相等 ">":大于">=":大于等于"<":小于"<=":小于等于 "like":模糊查询
int64 value = 2
值
message
dm.proto:30string CmpType = 1
"=":相等 "!=":不相等 ">":大于">=":大于等于"<":小于"<=":小于等于 "like":模糊查询
string value = 2
值
message
dm.proto:1212Used in:
string topic = 1
自定义主题需要以$custom 并包含设备名称{deviceName}及产品名称{productID}
int64 direction = 2
1:上行 2:下行 3:双向
message
dm.proto:1420Used in:
string tenantCode = 1
设备创建默认分配给的租户
int64 projectID = 2
设备创建默认分配给的项目
int64 areaID = 3
设备创建默认分配给的区域ID
int64 deptID = 4
设备创建默认分配给的部门
message
dm.proto:1890Used as response type in: DeviceManage.deviceBindTokenCreate, DeviceManage.deviceBindTokenRead
string token = 1
配网token
int64 status = 2
token状态 1:初始状态 2: 设备已上报
message
dm.proto:1517Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
string productID = 1
产品id
string deviceName = 2
设备名称
message
dm.proto:1920Used in:
int64 rangeID = 1
map<string, int64> count = 2
message
dm.proto:1522Used in:
string productID = 1
产品id
string deviceName = 2
设备名称
string dataID = 3
属性id
message
dm.proto:1528Used in:
string productID = 1
产品id
string deviceName = 2
设备名称
int64 code = 3
string msg = 4
message
dm.proto:1217Used in:
string productID = 1
产品id
string deviceName = 2
设备名称
optional sign = 3
签名
message
dm.proto:1254Used as request type in: DeviceManage.deviceGatewayMultiDelete, DeviceManage.deviceGatewayMultiUpdate
optional gateway = 1
bool isNotNotify = 2
不通知网关设备状态做了调整
repeated list = 3
message
dm.proto:1223Used in:
string signature = 3
子设备绑定签名串。 签名算法： 1. 签名原串，将产品 ID 设备名称，随机数，时间戳拼接：text=${product_id}${device_name};${random};${expiration_time} 2. 使用设备 Psk 密钥，或者证书的 Sha1 摘要，进行签名：hmac_sha1(device_secret, text)
int64 random = 4
随机数。
int64 timestamp = 5
时间戳，单位：秒。
string signMethod = 6
签名算法。支持 hmacsha1、hmacsha256
message
dm.proto:1834Used as request type in: DeviceManage.deviceGroupMultiCreate, DeviceManage.deviceGroupMultiDelete, DeviceManage.deviceGroupMultiUpdate
string productID = 1
产品id
string deviceName = 2
设备ID 必填
repeated int64 groupIDs = 3
string purpose = 4
message
dm.proto:1361Used as request type in: DeviceManage.deviceInfoCreate, DeviceManage.deviceInfoUpdate
Used as response type in: DeviceManage.deviceInfoRead
Used as field type in: ,
int64 id = 34
string tenantCode = 26
租户号,只有default租户能查到这个字段
string productID = 1
产品id 只读
int64 projectID = 2
项目id 只读
int64 areaID = 3
项目区域id
string areaIDPath = 42
区域id 路径
string productName = 4
产品名称 只读
string deviceName = 5
设备名称 读写
int64 createdTime = 6
创建时间 只读
string secret = 7
设备秘钥 只读
string cert = 8
设备证书 只读
string imei = 9
IMEI号信息 只读
string mac = 10
MAC号信息 只读
optional version = 11
固件版本 读写
string hardInfo = 12
模组硬件型号 只读
string softInfo = 13
模组软件版本 只读
optional Position = 14
设备定位,默认百度坐标系
optional address = 15
所在地址 读写
optional adcode = 45
地区编码 读写
map<string, string> tags = 16
设备标签
int64 isOnline = 17
在线状态 1离线 2在线 只读
int64 firstLogin = 18
激活时间 只读
int64 firstBind = 37
第一次绑定的时间
int64 lastBind = 50
最后一次绑定时间
int64 lastLogin = 19
最后上线时间 只读
int64 logLevel = 20
日志级别:1)关闭 2)错误 3)告警 4)信息 5)调试 读写
optional deviceAlias = 21
设备别名 读写
int64 mobileOperator = 22
移动运营商:1)移动 2)联通 3)电信 4)广电
optional phone = 23
手机号
optional iccid = 24
SIM卡卡号
map<string, string> schemaAlias = 25
设备物模型别名,如果是结构体类型则key为xxx.xxx
optional rssi = 27
设备信号（信号极好[-55— 0]，信号好[-70— -55]，信号一般[-85— -70]，信号差[-100— -85]）
int64 ratedPower = 28
额定功率:单位w/h
map<string, string> protocolConf = 29
map<string, string> subProtocolConf = 51
int64 status = 30
设备状态 1-未激活，2-在线，3-离线 4-异常(频繁上下线,告警中)
int64 isEnable = 31
是否启用
int64 deviceType = 33
设备类型:1:设备,2:网关,3:子设备
int64 netType = 35
网络类型
optional distributor = 36
过滤分销商的数据
optional expTime = 38
到期时间,如果为0,则不限制
int64 NeedConfirmJobID = 39
需要app确认升级的任务ID,为0是没有
string NeedConfirmVersion = 40
待确认升级的版本
int64 userID = 41
拥有者的用户ID
string productImg = 43
产品图片
int64 categoryID = 44
产品品类
string lastIp = 49
最后登录的ip,只读
optional desc = 47
optional dept = 52
过滤分销商的数据
optional Gateway = 46
子设备绑定的网关
int64 sort = 53
排序
message
dm.proto:457Used as response type in: DeviceManage.deviceModuleVersionRead
Used as field type in:
int64 id = 1
string productID = 2
string deviceName = 3
string moduleCode = 4
string version = 5
message
dm.proto:1844Used as request type in: DeviceManage.deviceProfileUpdate
Used as response type in: DeviceManage.deviceProfileRead
Used as field type in:
optional device = 1
string code = 2
string params = 3
message
dm.proto:1851Used as request type in: DeviceManage.deviceProfileDelete, DeviceManage.deviceProfileRead
optional device = 1
string code = 2
message
dm.proto:1803Used as request type in: DeviceManage.deviceSchemaCreate, DeviceManage.deviceSchemaUpdate
Used as field type in: ,
string productID = 1
产品id 必填
string deviceName = 17
设备ID 必填
int64 tag = 3
物模型标签 1:自定义 2:可选 3:必选 必选不可删除
int64 type = 2
物模型类型 1:property属性 2:event事件 3:action行为
string identifier = 4
标识符
optional name = 5
功能名称
optional desc = 6
描述
int64 required = 7
是否必须 1:是 2:否
int64 isCanSceneLinkage = 8
是否支持场景联动控制
int64 funcGroup = 14
功能分类: 1:普通功能 2:系统功能
int64 userPerm = 15
用户权限操作: 1:r(只读) 3:rw(可读可写)
int64 controlMode = 16
控制模式: 1: 可以群控,可以单控 2:只能单控
int64 isHistory = 10
是否存储历史记录
int64 isPassword = 18
是否是密码类型,密码类型需要加掩码
optional affordance = 11
各功能类型的详细参数定义
string extendConfig = 12
拓展参数
int64 order = 13
排序
message
dm.proto:540Used in:
string productID = 1
产品id
string productName = 4
产品名称 只读
string deviceName = 2
设备名称
string productImg = 3
产品图片
optional deviceAlias = 5
设备别名 读写
message
dm.proto:491Used as request type in: DeviceManage.deviceTransfer, userDevice.userDeviceTransfer
optional device = 1
设备信息
repeated devices = 2
设备信息
int64 srcProjectID = 3
指定原来的项目ID,不写使用头
int64 transferTo = 4
转让给: 1: 某个人 2: 自己的某个项目
int64 userID = 5
用户id
int64 projectID = 6
项目id
int64 areaID = 7
转移到项目时指定区域ID
int64 isCleanData = 8
是否清除数据:1是 2否
message
dm.proto:9Used as request type in: DeviceManage.deviceBindTokenCreate, SchemaManage.commonSchemaInit, userDevice.userDeviceCollectIndex
Used as response type in: DeviceGroup.groupDeviceMultiCreate, DeviceGroup.groupDeviceMultiDelete, DeviceGroup.groupDeviceMultiUpdate, DeviceGroup.groupInfoDelete, DeviceGroup.groupInfoMultiCreate, DeviceGroup.groupInfoUpdate, DeviceInteract.actionResp, DeviceInteract.gatewayGetFoundSend, DeviceInteract.gatewayNotifyBindSend, DeviceManage.DeviceInfoMultiUpdate, DeviceManage.deviceGatewayMultiCreate, DeviceManage.deviceGatewayMultiDelete, DeviceManage.deviceGatewayMultiUpdate, DeviceManage.deviceGroupMultiCreate, DeviceManage.deviceGroupMultiDelete, DeviceManage.deviceGroupMultiUpdate, DeviceManage.deviceInfoBind, DeviceManage.deviceInfoCanBind, DeviceManage.deviceInfoCreate, DeviceManage.deviceInfoDelete, DeviceManage.deviceInfoUnbind, DeviceManage.deviceInfoUpdate, DeviceManage.deviceMove, DeviceManage.deviceOnlineMultiFix, DeviceManage.deviceProfileDelete, DeviceManage.deviceProfileUpdate, DeviceManage.deviceReset, DeviceManage.deviceSchemaCreate, DeviceManage.deviceSchemaMultiCreate, DeviceManage.deviceSchemaMultiDelete, DeviceManage.deviceSchemaUpdate, DeviceManage.deviceTransfer, DeviceManage.rootCheck, DeviceMsg.abnormalLogCreate, OtaManage.otaFirmwareDeviceCancel, OtaManage.otaFirmwareDeviceConfirm, OtaManage.otaFirmwareDeviceRetry, OtaManage.otaFirmwareInfoDelete, OtaManage.otaFirmwareJobUpdate, OtaManage.otaModuleInfoDelete, OtaManage.otaModuleInfoUpdate, ProductManage.productCategoryDelete, ProductManage.productCategorySchemaMultiCreate, ProductManage.productCategorySchemaMultiDelete, ProductManage.productCategorySchemaMultiUpdate, ProductManage.productCategoryUpdate, ProductManage.productConfigUpdate, ProductManage.productCustomUpdate, ProductManage.productInfoCreate, ProductManage.productInfoDelete, ProductManage.productInfoUpdate, ProductManage.productInit, ProductManage.productSchemaCreate, ProductManage.productSchemaDelete, ProductManage.productSchemaMultiCreate, ProductManage.productSchemaTslImport, ProductManage.productSchemaUpdate, ProtocolManage.ProtocolScriptDelete, ProtocolManage.ProtocolScriptDeviceDelete, ProtocolManage.ProtocolScriptDeviceUpdate, ProtocolManage.ProtocolScriptUpdate, ProtocolManage.protocolInfoDelete, ProtocolManage.protocolInfoUpdate, ProtocolManage.protocolServiceDelete, ProtocolManage.protocolServiceUpdate, RemoteConfig.RemoteConfigCreate, RemoteConfig.RemoteConfigPushAll, SchemaManage.commonSchemaCreate, SchemaManage.commonSchemaDelete, SchemaManage.commonSchemaInit, SchemaManage.commonSchemaUpdate, userDevice.userDeivceShareMultiAccept, userDevice.userDeviceCollectMultiCreate, userDevice.userDeviceCollectMultiDelete, userDevice.userDeviceShareDelete, userDevice.userDeviceShareMultiDelete, userDevice.userDeviceShareUpdate, userDevice.userDeviceTransfer
(message has no fields)
message
dm.proto:875设备的日志数据
Used in:
int64 timestamp = 1
发生时间戳(毫秒时间戳)
string type = 2
事件类型: 信息:info 告警alert 故障:fault
string dataID = 3
属性id
string params = 4
获取到的值
string deviceName = 5
设备名(不填获取产品下所有设备)
message
dm.proto:1960下面是ota固件管理模块的消息
int64 createdTime = 1
创建时间 只读
int64 firmwareID = 2
string productID = 3
string name = 4
升级包名称
string version = 5
升级包版本
int32 isDiff = 6
是否差分包,1:整包,2:差分
string signMethod = 7
签名方法 MD5/SHA
optional desc = 8
描述
optional extData = 9
自定义数据
repeated files = 10
产品信息
message
dm.proto:2067Used in:
string name = 1
int64 size = 2
string filePath = 3
string signature = 4
string fileMd5 = 5
message
dm.proto:1975Used in:
int64 createdTime = 1
创建时间 只读
int64 firmwareID = 2
string productID = 3
string productName = 4
string name = 5
升级包名称
string version = 6
升级包版本
int32 isDiff = 7
是否差分包,1:整包,2:差分
string signMethod = 8
签名方法 MD5/SHA
optional desc = 9
描述
optional extData = 10
自定义数据
repeated files = 11
产品信息
message
dm.proto:1992int64 firmwareID = 1
message
dm.proto:1995repeated string paths = 1
message
dm.proto:1998optional page = 1
分页信息 只获取一个则不填
int64 firmwareID = 2
string productID = 3
message
dm.proto:2003repeated list = 1
固件信息
int64 total = 2
总数(只有分页的时候会返回)
message
dm.proto:2007int64 firmwareID = 1
message
dm.proto:2050int64 createdTime = 1
创建时间 只读
int64 firmwareID = 2
string productID = 3
string productName = 4
string name = 5
升级包名称
string version = 6
升级包版本
int32 isDiff = 7
是否差分包,1:整包,2:差分
string signMethod = 8
optional desc = 10
描述
optional extData = 11
自定义数据
repeated files = 12
产品信息
message
dm.proto:1972int64 firmwareID = 1
message
dm.proto:1291int64 id = 1
int64 parentID = 2
string name = 4
message
dm.proto:1343Used as request type in: DeviceGroup.groupDeviceMultiCreate, DeviceGroup.groupDeviceMultiUpdate
int64 groupID = 1
repeated list = 2
message
dm.proto:1272Used as request type in: DeviceGroup.groupInfoCreate, DeviceGroup.groupInfoUpdate
Used as response type in: DeviceGroup.groupInfoRead
Used as field type in: ,
string purpose = 15
用途 不填默认为default
int64 areaID = 10
分组可以属于某个区域下
int64 projectID = 3
int64 id = 1
int64 parentID = 2
string name = 4
string desc = 5
int64 createdTime = 6
map<string, string> tags = 7
string productID = 8
string productName = 9
repeated devices = 11
int64 deviceCount = 12
int64 isLeaf = 13
repeated children = 14
DeviceInfoCount deviceInfoCount =11;
message
dm.proto:1297string purpose = 6
用途 不填默认为default
int64 areaID = 5
分组可以属于某个区域下
string name = 1
int64 parentID = 2
string productID = 3
string desc = 4
message
dm.proto:1333int64 id = 1
string name = 2
string desc = 3
map<string, string> tags = 4
string productID = 5
message
dm.proto:909设备的日志数据
Used in:
int64 timestamp = 1
发生时间戳(毫秒时间戳)
string action = 2
操作类型;connected:上线 disconnected:下线 property:属性 event:事件 action:操作 thing:物模型提交的操作为匹配的日志
string requestID = 3
请求ID
string traceID = 4
服务器端事务id
string topic = 5
主题
string content = 6
具体内容
int64 resultCode = 7
请求结果状态
string respPayload = 8
返回的内容
message
dm.proto:58Used in: ,
int64 id = 1
string idPath = 2
int64 noParentID = 3
message
dm.proto:64Used in:
int64 id = 1
string idPath = 2
int64 updatedTime = 3
message
dm.proto:2263Used in:
int64 id = 1
int64 firmwareID = 2
int64 jobID = 3
string productID = 4
string productName = 5
string deviceName = 6
string srcVersion = 7
string destVersion = 8
int64 step = 9
当前的升级进度 0-100% -1：升级失败。-2：下载失败。-3：校验失败。-4：烧写失败。
string detail = 10
详情
int64 status = 11
设备升级作业状态。1：待确认。 2：待推送。 3：已推送。 4：升级中。 5:升级成功 6: 升级失败. 7:已取消
int64 createdTime = 13
int64 updatedTime = 14
int64 isOnline = 15
只读 设备是否在线
message
dm.proto:1988Used in: ,
string filePath = 1
string name = 2
message
dm.proto:2041optional page = 1
int64 firmwareID = 2
optional size = 3
message
dm.proto:2046repeated list = 1
int64 total = 2
message
dm.proto:2020Used in:
int64 fileID = 1
int64 firmwareID = 2
string name = 3
string host = 4
string filePath = 5
int64 size = 6
string storage = 7
string signMethod = 8
string signature = 9
message
dm.proto:2010int64 fileID = 1
string name = 2
string host = 3
string filePath = 4
int64 size = 5
string storage = 6
string signMethod = 7
string signature = 8
message
dm.proto:2031Used in:
int64 fileID = 1
string name = 2
string host = 3
string filePath = 4
int64 size = 5
string storage = 6
string signature = 7
string signMethod = 7;
message
dm.proto:2126Used as response type in: OtaManage.otaFirmwareInfoRead
Used as field type in:
int64 id = 1
固件id
string name = 2
固件升级包名称
string version = 3
版本号
string productID = 4
产品id
string productName = 5
产品名称
int64 status = 6
状态
int64 createdTime = 7
添加时间
string signMethod = 8
签名方式:MD5/SHA256
string desc = 9
文件描述
string extra = 10
推给设备端端消息
repeated fileList = 11
文件列表
int64 isDiff = 12
整包or差包
int64 isNeedToVerify = 13
是否需要验证
string moduleCode = 14
模块编码
message
dm.proto:2147Used as request type in: OtaManage.otaFirmwareJobCreate, OtaManage.otaFirmwareJobUpdate
Used as response type in: OtaManage.otaFirmwareJobRead
Used as field type in:
int64 id = 1
int64 firmwareID = 2
升级包ID，升级包的唯一标识符。
int64 type = 3
升级包所属产品的JobType。 验证升级包:1 批量升级:2
int64 status = 4
批次状态,计划中:1 执行中:2 已完成:3 已取消:4
int64 upgradeType = 5
升级策略，1-静态，2-动态
repeated string srcVersions = 6
待升级版本号列表。 发起全量升级（TargetSelection=ALL）和灰度升级（TargetSelection=GRAY）任务时，可以传入该参数。 使用差分升级包发起全量升级和灰度升级任务时，该参数值需指定为差分升级包的待升级版本号（SrcVersion）。 发起定向升级（TargetSelection=SPECIFIC）或分组升级（TargetSelection=GROUP）任务时，不能传入该参数。 可以调用 QueryDeviceDetail ，查看设备 OTA 模块版本号（FirmwareVersion）。 列表中不能有重复的版本号。 最多可传入 10 个版本号。
待升级版本号列表。最多可传入10个版本号。用逗号分隔多个版本号
int64 retryInterval = 7
设备升级失败后，自动重试的时间间隔，单位为分钟。 动态升级 静态升级 -1 为不重试
int64 retryCount = 8
自动重试次数。1/2/5次 动态升级 静态升级
int64 timeoutInMinutes = 9
设备升级超时时间，单位为分钟。 动态升级 静态升级
int64 maximumPerMinute = 10
每分钟最多向多少个设备推送升级包下载URL。 动态升级 静态升级
int64 isOverwriteMode = 11
是否覆盖之前的升级任务。取值： 2（默认）：不覆盖。若设备已有升级任务，则只执行已有任务。 1：覆盖。设备只执行新的升级任务。此时 MultiModuleMode 不能传入 true。 动态升级 静态升级
是否覆盖之前的升级任务。取值：1（不覆盖）、2（覆盖）。
int64 isNeedPush = 12
物联网平台是否主动向设备推送升级任务。 1（默认）：是。批次任务创建完成后，物联网平台主动将升级任务，直接推送给升级范围内的在线设备。 此时，设备仍可主动向物联网平台发起请求，来获取 OTA 升级任务信息。 2：否。设备必须通过向物联网平台发起请求，来获取 OTA 升级任务信息。 动态升级
物联网平台是否主动向设备推送升级任务。
int64 isNeedConfirm = 13
如需自主控制设备 OTA 升级时，可配置此参数，通过手机 App 来控制，设备是否可进行 OTA 升级。手机 App 需您自行开发。 2（默认）：否。直接按照 NeedPush 设置，获取 OTA 升级任务信息。 1：是。设备无法获取 OTA 升级任务，需 App 侧确认 OTA 升级后，才能按照 NeedPush 设置，获取 OTA 升级任务信息。
int64 targetSelection = 14
升级范围。 1：全量升级。 2：定向升级。 3：灰度升级。 4：分组升级(不做) 5: 区域升级(不做)
optional dynamic = 15
optional static = 16
string target = 17
分组升级和区域升级填写对应的id
repeated string tenantCodes = 18
指定租户
int64 createdTime = 19
message
dm.proto:2246optional pageInfo = 1
int64 firmwareID = 2
string productID = 3
string deviceName = 4
message
dm.proto:2197Used in:
int64 dynamicMode = 1
动态升级模式。取值范围： 1（默认）：除了升级当前满足升级条件的设备，还将持续检查设备是否满足升级条件，对满足升级条件的设备进行升级。 2：仅对后续上报新版本号的设备生效。 动态升级
message
dm.proto:2206Used in:
repeated string targetDeviceNames = 1
定向升级的设备名称列表。 使用差分升级包进行定向升级时，要升级的设备的当前 OTA 模块版本号需与差分升级包的待升级版本号（SrcVersion）相同。 可以调用 QueryDeviceDetail ，查看设备 OTA 模块版本号（FirmwareVersion）。 列表中的设备所属的产品必须与升级包所属产品一致。 列表中不能有重复的设备名称。 最多可传入 200 个设备名称。 静态升级
定向升级的设备名称列表。最多可传入200个设备名称。以逗号分隔
int64 scheduleFinishTime = 2
指定结束升级的时间。 结束时间距发起时间（ScheduleTime）最少 1 小时，最多为 30 天。取值为 13 位毫秒值时间戳。 不传入该参数，则表示不会强制结束升级。 静态升级
指定结束升级的时间，单位为毫秒。
int64 scheduleTime = 3
指定发起 OTA 升级的时间。 定时时间范围需为当前时间的 5 分钟后至 7 天内。取值为秒时间戳。 不传入该参数，则表示立即升级。 静态升级
int64 grayPercent = 4
灰度的范围,小数点后两位, 1.23%为 123
message
dm.proto:436Used as request type in: OtaManage.otaModuleInfoCreate, OtaManage.otaModuleInfoUpdate
Used as response type in: OtaManage.otaModuleInfoRead
Used as field type in:
int64 id = 1
string code = 2
string name = 3
string desc = 4
string productID = 5
int64 createdTime = 6
message
dm.proto:17Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
int64 page = 1
int64 size = 2
repeated orders = 3
排序信息
message
dm.proto:22Used in:
string field = 1
排序的字段名
int64 sort = 2
排序方式：1 从小到大, 2 从大到小
message
dm.proto:1355Used in: ,
double longitude = 1
经度
double latitude = 2
纬度
message
dm.proto:575Used as request type in: ProductManage.productCategoryCreate, ProductManage.productCategoryUpdate
Used as response type in: ProductManage.productCategoryRead
Used as field type in: , ,
int64 id = 1
int64 parentID = 2
string name = 3
string headImg = 4
bool isUpdateHeadImg = 5
只有这个参数为true的时候才会更新产品图片,传参为产品图片的file path
optional desc = 6
repeated int64 idPath = 9
int64 isLeaf = 10
int64 deviceCount = 11
repeated children = 7
子节点
message
dm.proto:599Used as request type in: ProductManage.productCategorySchemaMultiCreate, ProductManage.productCategorySchemaMultiDelete, ProductManage.productCategorySchemaMultiUpdate
int64 productCategoryID = 1
repeated string identifiers = 5
过滤标识符列表
message
dm.proto:1416Used as request type in: ProductManage.productConfigUpdate
Used as field type in:
string productID = 1
产品id 只读
optional DevInit = 2
设备初始化配置
message
dm.proto:1204Used as request type in: ProductManage.productCustomUpdate
Used as response type in: ProductManage.productCustomRead
string productID = 1
int64 scriptLang = 3
脚本语言类型（默认JavaScript） 1:JavaScript 2:lua 3:python
optional transformScript = 2
协议转换脚本
optional loginAuthScript = 5
登录认证脚本
repeated customTopics = 4
自定义topic信息 只有mqtt协议有用
message
dm.proto:1457Used in:
string path = 2
int64 version = 3
版本号,递增
bool isUpdateUi = 4
message
dm.proto:1427Used as request type in: ProductManage.productInfoCreate, ProductManage.productInfoUpdate
Used as response type in: ProductManage.productInfoRead
Used as field type in: ,
int64 createdTime = 1
创建时间 只读
string productID = 2
产品id 只读
string productName = 3
产品名称
int64 authMode = 4
认证方式:1:账密认证,2:秘钥认证
int64 deviceType = 5
设备类型:1:设备,2:网关,3:子设备
int64 categoryID = 6
产品品类
int64 netType = 7
通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN
string protocolCode = 8
协议code,默认urMqtt,设备下发只会发送给主协议 urMqtt,urHttp,wumei,aliyun,huaweiyun,tuya
optional subProtocolCode = 24
子协议,主协议和子协议传输类型必须不相同, 设备控制下发只会发送给主协议, 当设备是音视频设备但是控制协议需要单独走的时候就可以把主协议定义为普通协议,子协议定义为音视频协议,这样就能实现音视频走音视频协议,控制走子协议
int64 autoRegister = 9
动态注册:1:关闭,2:打开,3:打开并自动创建设备
string secret = 10
动态注册产品秘钥 只读
optional desc = 11
描述
map<string, string> tags = 13
产品标签
string productImg = 14
产品图片
bool isUpdateProductImg = 15
只有这个参数为true的时候才会更新产品图片,传参为产品图片的file path
optional protocol = 16
主协议信息
optional subProtocol = 39
子协议信息
optional category = 17
map<string, string> protocolConf = 18
map<string, string> subProtocolConf = 25
optional trialTime = 38
试用时间(单位为天,为0不限制)
string sceneMode = 19
场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景)
int64 status = 20
产品状态 1:启用 2:禁用 3:开发中
map<string, > customUi = 21
自定义ui
int64 deviceSchemaMode = 22
设备物模型模式:1:关闭,2:设备自动创建3: 设备自动创建及上报无定义自动创建
int64 bindLevel = 23
绑定级别: 1:强绑定(默认,只有用户解绑之后才能绑定) 2:中绑定(可以通过token强制绑定设备) 3:弱绑定(app可以内部解绑被绑定的设备)
optional config = 30
产品配置
message
dm.proto:1166Used in: ,
int64 id = 1
string productID = 2
string content = 3
int64 createdTime = 4
message
dm.proto:1729Used in: , , ,
string productID = 1
产品id 必填
int64 type = 2
物模型类型 1:property属性 2:event事件 3:action行为
int64 tag = 3
物模型标签 1:自定义 2:可选 3:必选 必选不可删除
string identifier = 4
标识符
optional name = 5
功能名称
optional desc = 6
描述
int64 required = 7
是否必须 1:是 2:否
int64 isCanSceneLinkage = 8
是否支持场景联动控制
int64 funcGroup = 14
功能分类: 1:普通功能 2:系统功能
int64 userPerm = 15
用户权限操作: 1:r(只读) 3:rw(可读可写)
int64 controlMode = 16
控制模式: 1: 可以群控,可以单控 2:只能单控
int64 isHistory = 10
是否存储历史记录
int64 isPassword = 17
是否是密码类型,密码类型需要加掩码
optional affordance = 11
各功能类型的详细参数定义
string extendConfig = 12
拓展参数
int64 order = 13
排序
message
dm.proto:1150Used in:
string productID = 1
string deviceName = 2
设备名
int64 code = 3
设备返回状态码
string msg = 4
返回状态
string msgToken = 5
调用id
string sysMsg = 6
系统错误信息
int64 sysCode = 7
系统错误码
message
dm.proto:1097Used as response type in: DeviceInteract.propertyControlRead, DeviceInteract.propertyControlSend
int64 code = 1
设备返回状态码
string msg = 2
返回状态
string msgToken = 3
调用id
message
dm.proto:783Used in:
int64 code = 1
设备返回状态码
string msg = 2
返回状态
string msgToken = 3
调用id
int64 timestamp = 4
上报时间戳(毫秒时间戳)
string params = 5
获取到的值
string productID = 6
产品id (必填)
string deviceName = 7
设备名(必填)
string sysMsg = 8
系统错误信息
int64 sysCode = 9
系统错误码
message
dm.proto:857获取对应日志信息
Used as response type in: DeviceMsg.propertyLogIndex, DeviceMsg.propertyLogLatestIndex, DeviceMsg.propertyLogLatestIndex2
int64 total = 1
总数
repeated list = 2
message
dm.proto:848设备的日志数据
Used in:
int64 timestamp = 1
发生时间戳(毫秒时间戳)
string productID = 5
产品名称
string deviceName = 2
设备名称
string dataID = 3
属性id
string value = 4
获取到的值
message
dm.proto:837获取对应日志信息
Used as request type in: DeviceMsg.propertyLogLatestIndex, DeviceMsg.shadowIndex
string productID = 2
产品id (必填)
string deviceName = 1
设备名(必填)
repeated string dataIDs = 3
获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条,如果没有获取到的不会返回值
message
dm.proto:744Used in:
int64 id = 1
string group = 2
string key = 3
string label = 4
bool isRequired = 5
int64 sort = 6
message
dm.proto:753Used in:
int64 id = 1
map<string, string> config = 2
string desc = 3
message
dm.proto:727Used as request type in: ProtocolManage.protocolInfoCreate, ProtocolManage.protocolInfoUpdate
Used as response type in: ProtocolManage.protocolInfoRead
Used as field type in: ,
int64 id = 1
string name = 2
string code = 3
iThings,iThings-thingsboard,wumei,aliyun,huaweiyun,tuya
string type = 4
协议类型: 普通设备(默认):normal 音视频:media
string transProtocol = 5
传输协议: mqtt,tcp,udp
string desc = 6
repeated string endpoints = 7
string etcdKey = 8
int64 isEnableSyncProduct = 13
是否支持主动同步产品信息
int64 isEnableSyncDevice = 14
是否支持主动同步设备信息
repeated configFields = 9
配置字段列表,没有可以不传
repeated configInfos = 10
配置列表
repeated productFields = 11
产品需要的配置字段列表
repeated deviceFields = 12
设备需要的配置字段列表
message
dm.proto:630Used as request type in: ProtocolManage.ProtocolScriptCreate, ProtocolManage.ProtocolScriptUpdate
Used as response type in: ProtocolManage.ProtocolScriptRead
Used as field type in: ,
int64 id = 1
string name = 2
名称
int64 triggerDir = 3
1:up 2:down
int64 triggerTimer = 4
收到前处理1:before 2:after
string triggerHandle = 5
对应 mqtt topic的第一个 thing ota config 等等
string triggerType = 6
操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为
optional desc = 7
描述
string script = 8
脚本内容
int64 status = 9
状态:是否启用
int64 createdTime = 10
创建时间
message
dm.proto:660Used as request type in: ProtocolManage.ProtocolScriptDeviceCreate, ProtocolManage.ProtocolScriptDeviceUpdate
Used as response type in: ProtocolManage.ProtocolScriptDeviceRead
Used as field type in:
int64 id = 1
int64 triggerSrc = 2
产品:1 设备:2
string productID = 3
string deviceName = 4
int64 scriptID = 5
脚本对应的ID
int64 priority = 6
执行优先级 大于0
int64 status = 7
状态:是否启用
int64 createdTime = 8
创建时间
optional script = 9
脚本信息
optional product = 10
withDevice时,绑定的是产品返回
optional device = 11
withDevice时,绑定的是设备返回
message
dm.proto:717Used as request type in: ProtocolManage.protocolServiceUpdate
Used as field type in:
int64 id = 1
string code = 2
协议code
string ip = 3
协议服务的ip地址
int64 port = 4
监听的端口,如果没有填0即可
int64 status = 5
服务状态
int64 updatedTime = 6
更新时间
int64 createdTime = 7
首次加入时间
message
dm.proto:71发布消息结构体
Used in: ,
string handle = 1
对应 mqtt topic的第一个 thing ota config 等等
string type = 2
操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为
bytes payload = 3
int64 timestamp = 4
毫秒时间戳
string productID = 5
string deviceName = 6
string explain = 7
内部使用的拓展字段
string protocolCode = 8
如果有该字段则回复的时候也会带上该字段
message
dm.proto:1064获取异步消息的请求
Used as request type in: DeviceInteract.actionRead, DeviceInteract.propertyControlRead
string productID = 1
产品id
string deviceName = 2
设备名
string msgToken = 3
调用id
message
schemaInfo.proto:7repeated input = 1
调用参数
repeated output = 2
返回参数
message
schemaInfo.proto:23物模型定义
Used in: , ,
string type = 1
参数类型: bool int string struct float timestamp array enum
map<string, string> mapping = 2
枚举及bool类型:bool enum
string min = 3
数值最小值:int float
string max = 4
数值最大值:int string float
string start = 5
初始值:int float
string step = 6
步长:int float
string unit = 7
单位:int float
repeated specs = 8
结构体:struct
optional arrayInfo = 9
数组:array
message
schemaInfo.proto:17string type = 1
事件类型: 信息:info 告警alert 故障:fault
repeated params = 2
事件参数
message
schemaInfo.proto:43物模型参数
Used in: ,
string identifier = 1
参数标识符
string name = 2
参数名称
optional define = 3
参数定义
message
schemaInfo.proto:12string mode = 1
读写类型: r(只读) rw(可读可写)
optional define = 2
参数定义
message
schemaInfo.proto:36物模型结构体说明
Used in:
string identifier = 1
参数标识符
string name = 2
参数名称
optional dataType = 3
参数定义
message
dm.proto:1040Used in:
int64 timestamp = 1
发生时间戳(毫秒时间戳)
int64 loglevel = 2
操作类型;显示相应的操作名称、API名称、服务的method
string content = 3
具体内容
message
dm.proto:977设备的日志数据
Used in:
int64 timestamp = 1
发生时间戳(毫秒时间戳)
string account = 2
账号
int64 userID = 4
string productID = 5
string deviceName = 6
string action = 7
操作类型 propertySend:属性控制 actionSend:操作控制 propertyGetReportSend:获取最新属性请求
string dataID = 8
identify
string traceID = 9
服务器端事务id
string content = 10
操作的内容
int64 resultCode = 11
请求结果状态,200为成功
message
dm.proto:39Used in:
int64 timeoutToFail = 1
超时失败时间
int64 requestTimeout = 2
请求超时,超时后会进行重试
int64 retryInterval = 3
重试间隔
message
dm.proto:763设备的日志数据
Used in:
string dataID = 1
属性id
string value = 2
获取到的值
int64 updatedDeviceTime = 3
更新到设备的时间
message
dm.proto:536Used in: ,
int64 perm = 1
1:r(只读) 3(默认):rw(可读可写)
message
dm.proto:941设备的日志数据
Used in:
int64 timestamp = 1
发生时间戳(毫秒时间戳)
int64 status = 2
设备状态
string productID = 3
产品id
string deviceName = 4
设备名
message
dm.proto:12Used in: ,
int64 start = 1
int64 end = 2
message
dm.proto:570Used as request type in: userDevice.userDeviceCollectMultiCreate, userDevice.userDeviceCollectMultiDelete
Used as response type in: userDevice.userDeviceCollectIndex
repeated devices = 1
message
dm.proto:523Used as request type in: userDevice.userDeviceShareCreate, userDevice.userDeviceShareUpdate
Used as response type in: userDevice.userDeviceShareRead
Used as field type in:
int64 id = 1
optional device = 2
设备信息
int64 sharedUserID = 3
分享的对象
string sharedUserAccount = 7
分享的账号(只读)
map<string, > schemaPerm = 4
物模型权限,只需要填写需要授权并授权的物模型id
map<string, > accessPerm = 5
操作权限 hubLog:设备消息记录,ota:ota升级权限,deviceTiming:设备定时
int64 authType = 9
授权类型:1:全部授权 2:部分授权
int64 projectID = 6
设备归属的项目
optional expTime = 10
到期时间,如果为0,则不限制
int64 createdTime = 8
message
dm.proto:548Used as request type in: userDevice.userDeviceShareMultiCreate
Used as response type in: userDevice.userDeivceShareMultiIndex
repeated devices = 1
设备信息
map<string, > schemaPerm = 2
物模型权限,只需要填写需要授权并授权的物模型id
map<string, > accessPerm = 3
操作权限 hubLog:设备消息记录,ota:ota升级权限,deviceTiming:设备定时
int64 authType = 4
授权类型:1:全部授权 2:部分授权
int64 projectID = 5
设备归属的项目
int64 expTime = 6
有效期,如果为0,则不限制
int64 createdTime = 7
int64 userID = 8
生成分享的人id
message
dm.proto:559Used as request type in: userDevice.userDeivceShareMultiIndex
Used as response type in: userDevice.userDeviceShareMultiCreate
string shareToken = 1
message
dm.proto:502Used as request type in: userDevice.userDeviceShareDelete, userDevice.userDeviceShareRead
int64 id = 1
optional device = 2
设备信息
message
dm.proto:50Used as request type in: DeviceGroup.groupInfoDelete, OtaManage.otaFirmwareInfoDelete, OtaManage.otaFirmwareInfoRead, OtaManage.otaFirmwareJobRead, OtaManage.otaModuleInfoDelete, ProductManage.productCategoryDelete, ProtocolManage.ProtocolScriptDelete, ProtocolManage.ProtocolScriptDeviceDelete, ProtocolManage.ProtocolScriptDeviceRead, ProtocolManage.ProtocolScriptRead, ProtocolManage.protocolInfoDelete, ProtocolManage.protocolServiceDelete, SchemaManage.commonSchemaDelete
Used as response type in: DeviceGroup.groupInfoCreate, OtaManage.otaFirmwareInfoCreate, OtaManage.otaFirmwareInfoUpdate, OtaManage.otaFirmwareJobCreate, OtaManage.otaModuleInfoCreate, ProductManage.productCategoryCreate, ProtocolManage.ProtocolScriptCreate, ProtocolManage.ProtocolScriptDeviceCreate, ProtocolManage.protocolInfoCreate, userDevice.userDeviceShareCreate
int64 id = 1
message
dm.proto:45Used as request type in: OtaManage.otaModuleInfoRead, ProtocolManage.protocolInfoRead
int64 id = 1
string code = 2
message
dm.proto:1082Used in:
string code = 1
string params = 2
message
dm.proto:1506Used in:
optional device = 1
int64 isOnline = 2
int64 connectAt = 3