package dm

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc groupDeviceMultiCreate (GroupDeviceMultiSaveReq, Empty)

  dm.proto:302

  创建分组设备

• rpc groupDeviceMultiDelete (GroupDeviceMultiDeleteReq, Empty)

  dm.proto:306

  删除分组设备

  message GroupDeviceMultiDeleteReq

  dm.proto:1506

  • int64 groupID = 1

  • string purpose = 2

    用途 不填默认为default

  • repeated DeviceCore list = 3

• rpc groupDeviceMultiUpdate (GroupDeviceMultiSaveReq, Empty)

  dm.proto:304

  更新分组设备

• rpc groupInfoCreate (GroupInfo, WithID)

  dm.proto:290

  创建分组

• rpc groupInfoDelete (WithID, Empty)

  dm.proto:300

  删除分组

• rpc groupInfoIndex (GroupInfoIndexReq, GroupInfoIndexResp)

  dm.proto:294

  获取分组信息列表

  message GroupInfoIndexReq

  dm.proto:1470

  • int64 areaID = 5

    分组可以属于某个区域下

  • optional PageInfo 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 DeviceCore hasDevice = 17

  message GroupInfoIndexResp

  dm.proto:1482

  • repeated GroupInfo list = 1

  • int64 total = 2

    repeated GroupInfo listAll = 3;

• rpc groupInfoMultiCreate (GroupInfoMultiCreateReq, Empty)

  dm.proto:291

  message GroupInfoMultiCreateReq

  dm.proto:1423

  • repeated GroupInfo groups = 1

• rpc groupInfoRead (GroupInfoReadReq, GroupInfo)

  dm.proto:296

  获取分组信息详情

  message GroupInfoReadReq

  dm.proto:1463

  • int64 id = 1

    id

  • bool withChildren = 2

  • string purpose = 15

    用途 不填默认为default

• rpc groupInfoUpdate (GroupInfo, Empty)

  dm.proto:298

  更新分组

设备交互

• rpc actionRead (RespReadReq, ActionSendResp)

  dm.proto:350

  获取异步调用设备行为的结果

• rpc actionResp (ActionRespReq, Empty)

  dm.proto:353

  回复调用设备行为

  message ActionRespReq

  dm.proto:1240

  • string productID = 1

    产品id 获取产品id下的所有设备信息

  • string deviceName = 2

    设备名

  • string msgToken = 3

    调用id

  • string outputParams = 4

    输出参数 注意：此字段可能返回 null，表示取不到有效值。

  • string msg = 5

    返回状态

  • int64 code = 6

    设备返回状态码

• rpc actionSend (ActionSendReq, ActionSendResp)

  dm.proto:348

  调用设备行为

  message ActionSendReq

  dm.proto:1200

  • string productID = 1

    产品id 获取产品id下的所有设备信息

  • string deviceName = 2

    设备名

  • string actionID = 3

    产品数据模板中行为功能的标识符，由开发者自行根据设备的应用场景定义

  • string inputParams = 4

    输入参数

  • bool isAsync = 5

    是否异步获取

  • optional SendOption option = 6

    异步选项

• rpc edgeSend (EdgeSendReq, EdgeSendResp)

  dm.proto:374

  提供给边缘端进行http访问

  message EdgeSendReq

  dm.proto:1261

  • string handle = 1

    对应 mqtt topic的第一个 thing ota config 等等

  • string type = 2

    操作类型 从topic中提取 物模型下就是 property属性 event事件 action行为

  • bytes payload = 3

  • string productID = 4

  • string deviceName = 5

  message EdgeSendResp

  dm.proto:1270

  • bytes payload = 3

• rpc gatewayGetFoundSend (GatewayGetFoundReq, Empty)

  dm.proto:369

  获取网关拓扑关系

  message GatewayGetFoundReq

  dm.proto:1256

  • string productID = 1

    产品id

  • string deviceName = 2

    设备名

• rpc gatewayNotifyBindSend (GatewayNotifyBindSendReq, Empty)

  dm.proto:371

  通知网关绑定子设备

  message GatewayNotifyBindSendReq

  dm.proto:1274

  • optional DeviceCore gateway = 1

  • repeated DeviceCore subDevices = 2

• rpc propertyControlMultiSend (PropertyControlMultiSendReq, PropertyControlMultiSendResp)

  dm.proto:363

  批量调用设备属性

  message PropertyControlMultiSendReq

  dm.proto:1290

  • string productID = 1

    产品id

  • repeated string deviceNames = 2

    设备名

  • repeated DeviceCore 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 PropertyControlMultiSendResp

  dm.proto:1313

  • repeated PropertyControlSendMsg list = 1

    批量设备返回结果列表

• rpc propertyControlRead (RespReadReq, PropertyControlSendResp)

  dm.proto:365

  获取异步调用设备属性的结果

• rpc propertyControlSend (PropertyControlSendReq, PropertyControlSendResp)

  dm.proto:361

  调用设备属性

  message PropertyControlSendReq

  dm.proto:1223

  • string productID = 1

    产品id

  • string deviceName = 2

    设备名

  • string data = 3

    属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义

  • int64 shadowControl = 4

    设备影子控制 0:自动,当设备不在线的时候设置设备影子,设备在线时直接下发给设备 1:只实时下发,不在线报错 2:如果有设备影子只修改影子,没有的也不下发 3: 只修改云端的值,不下发设备

  • bool isAsync = 6

    是否异步操作 异步情况通过获取接口来获取

  • optional WithProfile withProfile = 7

  • int64 syncTimeout = 8

    同步超时时间(单位:秒)

• rpc propertyGetReportMultiSend (PropertyGetReportMultiSendReq, PropertyGetReportMultiSendResp)

  dm.proto:358

  请求设备获取设备最新属性

  message PropertyGetReportMultiSendReq

  dm.proto:873

  • repeated string dataIDs = 1

    获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条

  • string productID = 2

    产品id

  • repeated string deviceNames = 3

    设备名

  • repeated DeviceCore devices = 4

    如果是不同的产品,则传这个字段,上面两个参数填了优先使用

  • int64 areaID = 5

    控制一个区域的设备

  • string areaIDPath = 6

    根据区域路径控制设备

  • int64 groupID = 7

    控制一个组的设备

  message PropertyGetReportMultiSendResp

  dm.proto:883

  • repeated PropertyGetReportSendMsg list = 1

    批量设备返回结果列表

• rpc propertyGetReportSend (PropertyGetReportSendReq, PropertyGetReportSendResp)

  dm.proto:356

  请求设备获取设备最新属性

  message PropertyGetReportSendReq

  dm.proto:847

  • string productID = 1

    产品id (必填)

  • string deviceName = 2

    设备名(必填)

  • repeated string dataIDs = 3

    获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条

  message PropertyGetReportSendResp

  dm.proto:853

  • int64 code = 1

    设备返回状态码

  • string msg = 2

    返回状态

  • string msgToken = 3

    调用id

  • int64 timestamp = 4

    上报时间戳(毫秒时间戳)

  • string params = 5

    获取到的值

• rpc sendMsg (SendMsgReq, SendMsgResp)

  dm.proto:367

  发送消息给设备 -- 调试使用

  message SendMsgReq

  dm.proto:1279

  • string topic = 1

    发送的topic

  • bytes payload = 2

    发送的数据

  message SendMsgResp

  dm.proto:1284

  (message has no fields)

设备管理

• rpc DeviceInfoMultiUpdate (DeviceInfoMultiUpdateReq, Empty)

  dm.proto:106

  批量更新设备状态

  message DeviceInfoMultiUpdateReq

  dm.proto:1709

  • repeated DeviceCore devices = 1

    产品id

  • optional CompareInt64 FilterDistributorID = 2

  • int64 areaID = 4

    项目区域id

  • optional IDPath distributor = 20

    分销商的数据

  • int64 ratedPower = 28

    额定功率:单位w/h

• rpc deviceBindTokenCreate (Empty, DeviceBindTokenInfo)

  dm.proto:111

• rpc deviceBindTokenRead (DeviceBindTokenReadReq, DeviceBindTokenInfo)

  dm.proto:110

  message DeviceBindTokenReadReq

  dm.proto:2061

  • string token = 1

    配网token

• rpc deviceCount (DeviceCountReq, DeviceCountResp)

  dm.proto:135

  message DeviceCountReq

  dm.proto:2084

  • repeated string countTypes = 1

    在线设备数:status,设备类型: deviceType

  • int64 rangeType = 2

    0:全部 1:area 2:group

  • repeated int64 rangeIDs = 3

    //统计的id列表, areaID或者groupID

  message DeviceCountResp

  dm.proto:2090

  • repeated DeviceCountInfo list = 1

• rpc deviceGatewayIndex (DeviceGatewayIndexReq, DeviceGatewayIndexResp)

  dm.proto:127

  获取绑定信息的设备信息列表

  message DeviceGatewayIndexReq

  dm.proto:1397

  • optional PageInfo page = 1

  • optional DeviceCore gateway = 2

    获取网关下子设备列表

  • optional DeviceCore subDevice = 3

    获取子设备绑定的网关列表

  message DeviceGatewayIndexResp

  dm.proto:1403

  • repeated DeviceCore list = 1

  • int64 total = 2

• rpc deviceGatewayMultiCreate (DeviceGatewayMultiCreateReq, Empty)

  dm.proto:123

  绑定网关下子设备设备

  message DeviceGatewayMultiCreateReq

  dm.proto:1389

  • optional DeviceCore gateway = 1

  • bool isNotNotify = 2

    不通知网关设备状态做了调整

  • bool isAuthSign = 3

    是否校验设备签名

  • repeated DeviceGatewayBindDevice list = 4

• rpc deviceGatewayMultiDelete (DeviceGatewayMultiSaveReq, Empty)

  dm.proto:129

  删除网关下子设备

• rpc deviceGatewayMultiUpdate (DeviceGatewayMultiSaveReq, Empty)

  dm.proto:125

  绑定网关下子设备设备

• rpc deviceGroupMultiCreate (DeviceGroupMultiSaveReq, Empty)

  dm.proto:157

  将设备加到多个分组中

• rpc deviceGroupMultiDelete (DeviceGroupMultiSaveReq, Empty)

  dm.proto:161

  删除设备所在分组

• rpc deviceGroupMultiUpdate (DeviceGroupMultiSaveReq, Empty)

  dm.proto:159

  更新设备所在分组

• rpc deviceInfoBind (DeviceInfoBindReq, Empty)

  dm.proto:109

  message DeviceInfoBindReq

  dm.proto:2069

  • optional DeviceCore device = 1

  • int64 areaID = 2

  • string token = 3

    中绑定的token

• rpc deviceInfoCanBind (DeviceInfoCanBindReq, Empty)

  dm.proto:113

  message DeviceInfoCanBindReq

  dm.proto:2030

  • optional DeviceCore device = 1

• rpc deviceInfoCount (DeviceInfoCountReq, DeviceInfoCount)

  dm.proto:131

  设备计数

  message DeviceInfoCountReq

  dm.proto:2099

  • optional TimeRange timeRange = 1

  • repeated int64 areaIDs = 2

  • repeated int64 groupIDs = 3

  message DeviceInfoCount

  dm.proto:2111

  • int64 online = 1

  • int64 offline = 2

  • int64 inactive = 3

  • int64 unknown = 4

  • int64 total = 5

• rpc deviceInfoCreate (DeviceInfo, Empty)

  dm.proto:97

  新增设备

• rpc deviceInfoDelete (DeviceInfoDeleteReq, Empty)

  dm.proto:102

  删除设备

  message DeviceInfoDeleteReq

  dm.proto:1680

  • string productID = 1

    产品id

  • string deviceName = 2

    设备名称

• rpc deviceInfoIndex (DeviceInfoIndexReq, DeviceInfoIndexResp)

  dm.proto:104

  获取设备信息列表

  message DeviceInfoIndexReq

  dm.proto:1718

  • optional PageInfo 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 Point Position = 7

    设备定位,默认百度坐标系

  • int64 areaID = 36

  • repeated int64 areaIDs = 8

    区域ids

  • string areaIDPath = 32

    区域路径过滤

  • repeated string areaIDPaths = 34

    区域路径过滤

  • string deviceAlias = 9

    过滤条件:模糊查询 设备别名

  • int64 isOnline = 10

    在线状态过滤 1离线 2在线

  • int64 productCategoryID = 11

    产品品类id

  • repeated int64 productCategoryIDs = 33

    产品品类id

  • repeated DeviceCore 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 DeviceCore gateway = 17

    获取网关下子设备列表

  • int64 groupID = 18

  • repeated int64 groupIDs = 55

  • string groupIDPath = 56

  • repeated string groupIDPaths = 57

  • int64 notGroupID = 19

  • int64 parentGroupID = 42

  • string groupPurpose = 45

    设备分组用途 不填默认为default

  • string groupName = 43

    模糊查询

  • int64 notAreaID = 29

  • optional IDPath distributor = 20

    过滤分销商的数据

  • int64 status = 22

  • repeated int64 statuses = 35

  • optional CompareInt64 ratedPower = 28

    额定功率:单位w/h

  • int64 hasOwner = 30

    是否被人拥有

  • int64 userID = 31

    用户id查询

  • optional CompareInt64 expTime = 38

    到期时间

  • string iccid = 40

    SIM卡卡号

  • bool withGateway = 41

    同时返回子设备的网关

  • string protocolCode = 51

    协议查询

  • optional CompareInt64 rssi = 52

  • optional IDPath dept = 53

    过滤分销商的数据

  • map<string, CompareString> property = 54

    设备最新属性过滤,key为属性的id,如果是结构体则key为 aaa.bbb 数组为aaa.1

  message DeviceInfoIndexResp

  dm.proto:1770

  • repeated DeviceInfo list = 1

    设备信息

  • int64 total = 2

    总数(只有分页的时候会返回)

• rpc deviceInfoMultiBind (DeviceInfoMultiBindReq, DeviceInfoMultiBindResp)

  dm.proto:112

  批量绑定

  message DeviceInfoMultiBindReq

  dm.proto:2034

  • repeated DeviceCore devices = 1

  • int64 areaID = 2

  message DeviceInfoMultiBindResp

  dm.proto:2041

  • repeated DeviceError errs = 1

• rpc deviceInfoRead (DeviceInfoReadReq, DeviceInfo)

  dm.proto:108

  获取设备信息详情

  message DeviceInfoReadReq

  dm.proto:1703

  • string productID = 1

    产品id

  • string deviceName = 2

    设备名称

  • bool withGateway = 3

    同时返回子设备的网关

• rpc deviceInfoUnbind (DeviceInfoUnbindReq, Empty)

  dm.proto:114

  message DeviceInfoUnbindReq

  dm.proto:2045

  • string productID = 1

    产品id

  • string deviceName = 2

    设备名称

  • string secretType = 3

    中绑定,强制解绑参数 对参数（deviceName、nonce、productID、timestamp）按字典序升序排序。 将以上参数，按参数名称 = 参数值 & 参数名称 = 参数值拼接成字符串, 如："deviceName=xxx&nonce=2125656451&productID=xxx&timestamp=1687525491"。 使用 HMAC-sha1 算法对上一步中获得的字符串进行计算，密钥取secretType 取设备的物模型密码类型的属性。 将生成的结果使用 Base64 进行编码，即可获得最终的签名串放入 signature。

    采用秘钥的类型

  • string signature = 4

    签名

  • int64 timestamp = 5

    秒时间戳

  • string signType = 6

    hmacsha256 hmacsha1 hmacmd5(默认)

  • int64 nonce = 7

    随机数

• rpc deviceInfoUpdate (DeviceInfo, Empty)

  dm.proto:99

  更新设备

• rpc deviceModuleVersionIndex (DeviceModuleVersionIndexReq, DeviceModuleVersionIndexResp)

  dm.proto:120

  message DeviceModuleVersionIndexReq

  dm.proto:540

  • optional PageInfo page = 1

  • string productID = 2

  • string deviceName = 3

  • string moduleCode = 4

  message DeviceModuleVersionIndexResp

  dm.proto:547

  • int64 total = 1

  • repeated DeviceModuleVersion list = 2

• rpc deviceModuleVersionRead (DeviceModuleVersionReadReq, DeviceModuleVersion)

  dm.proto:119

  message DeviceModuleVersionReadReq

  dm.proto:526

  • int64 id = 1

    填id或者以下三个参数

  • string productID = 2

  • string deviceName = 3

  • string moduleCode = 4

• rpc deviceMove (DeviceMoveReq, Empty)

  dm.proto:117

  将设备信息迁移到新的设备中

  message DeviceMoveReq

  dm.proto:552

  • optional DeviceCore old = 1

    需要转移的设备

  • optional DeviceCore new = 2

    转移的对象

  • repeated string withTarget = 3

    设备配置-profile,schemaAlias:profile

• rpc deviceOnlineMultiFix (deviceOnlineMultiFixReq, Empty)

  dm.proto:100

  message deviceOnlineMultiFixReq

  dm.proto:1670

  • repeated deviceOnlineMultiFix devices = 1

• rpc deviceProfileDelete (DeviceProfileReadReq, Empty)

  dm.proto:138

• rpc deviceProfileIndex (DeviceProfileIndexReq, DeviceProfileIndexResp)

  dm.proto:140

  message DeviceProfileIndexReq

  dm.proto:2075

  • optional DeviceCore device = 1

  • repeated string codes = 2

  message DeviceProfileIndexResp

  dm.proto:2080

  • repeated DeviceProfile profiles = 1

• rpc deviceProfileRead (DeviceProfileReadReq, DeviceProfile)

  dm.proto:137

• rpc deviceProfileUpdate (DeviceProfile, Empty)

  dm.proto:139

• rpc deviceReset (DeviceResetReq, Empty)

  dm.proto:116

  设备重置

  message DeviceResetReq

  dm.proto:558

  • optional DeviceCore device = 1

    设备信息

  • bool log = 2

    日志清除

  • bool deviceSchema = 3

    设备物模型定义清除

  • bool bind = 4

    绑定关系解绑

  • bool info = 5

    设备信息恢复出厂设置,包含过期时间,名称,设备配置等

• rpc deviceSchemaCreate (DeviceSchema, Empty)

  dm.proto:146

  新增设备

• rpc deviceSchemaIndex (DeviceSchemaIndexReq, DeviceSchemaIndexResp)

  dm.proto:152

  获取设备物模型列表

  message DeviceSchemaIndexReq

  dm.proto:1955

  • optional PageInfo 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 DeviceSchemaIndexResp

  dm.proto:1972

  • repeated DeviceSchema list = 1

  • int64 total = 2

    总数(只有分页的时候会返回)

• rpc deviceSchemaMultiCreate (DeviceSchemaMultiCreateReq, Empty)

  dm.proto:148

  批量新增物模型,只新增没有的,已有的不处理

  message DeviceSchemaMultiCreateReq

  dm.proto:1941

  • string productID = 1

  • string deviceName = 3

  • repeated DeviceSchema list = 2

    物模型信息

• rpc deviceSchemaMultiDelete (DeviceSchemaMultiDeleteReq, Empty)

  dm.proto:150

  删除设备物模型

  message DeviceSchemaMultiDeleteReq

  dm.proto:1949

  • string productID = 1

    产品id 如果为空返回所有产品的信息

  • string deviceName = 3

  • repeated string identifiers = 2

    标识符

• rpc deviceSchemaTslRead (DeviceSchemaTslReadReq, DeviceSchemaTslReadResp)

  dm.proto:153

  message DeviceSchemaTslReadReq

  dm.proto:1997

  • string productID = 1

    产品id

  • string deviceName = 17

    设备ID 必填

  • bool withProductSchema = 20

    同时获取产品物模型

  message DeviceSchemaTslReadResp

  dm.proto:2003

  • string tsl = 1

    物模型tsl

• rpc deviceSchemaUpdate (DeviceSchema, Empty)

  dm.proto:144

  更新设备物模型

• rpc deviceTransfer (DeviceTransferReq, Empty)

  dm.proto:115

• rpc deviceTypeCount (DeviceTypeCountReq, DeviceTypeCountResp)

  dm.proto:133

  设备类型

  message DeviceTypeCountReq

  dm.proto:2105

  • optional TimeRange timeRange = 1

  • repeated int64 areaIDs = 2

  • repeated int64 groupIDs = 3

  message DeviceTypeCountResp

  dm.proto:2119

  • int64 device = 1

  • int64 gateway = 2

  • int64 subset = 3

  • int64 unknown = 4

• rpc rootCheck (RootCheckReq, Empty)

  dm.proto:95

  鉴定是否是root账号(提供给mqtt broker)

  message RootCheckReq

  dm.proto:1790

  • string username = 1

    用户名

  • string password = 2

    密码

  • string clientID = 3

    clientID

  • string ip = 4

    访问的ip地址

  • bytes certificate = 5

    客户端证书

设备消息

• rpc abnormalLogCreate (AbnormalLogInfo, Empty)

  dm.proto:326

• rpc abnormalLogIndex (AbnormalLogIndexReq, AbnormalLogIndexResp)

  dm.proto:325

  message AbnormalLogIndexReq

  dm.proto:1144

  实时获取对应信息

  • int64 projectID = 13

    只有管理员有权限

  • int64 areaID = 14

    只有管理员有权限

  • string areaIDPath = 15

    只有管理员有权限

  • repeated int64 areaIDs = 16

    只有管理员有权限

  • int64 productCategoryID = 17

    产品品类id

  • map<string, IDsInfo> BelongGroup = 18

    key是group的purpose, value是里面包含的分组id

  • string productID = 1

    产品id

  • string deviceName = 2

    设备名

  • int64 timeStart = 3

    获取时间的开始(毫秒时间戳)

  • int64 timeEnd = 4

    时间的结束(毫秒时间戳)

  • optional PageInfo page = 5

    分页信息

  • int64 userID = 9

  • int64 action = 10

  • string type = 11

    异常类型

  • int64 resultCode = 12

    请求结果状态,200为成功

  message AbnormalLogIndexResp

  dm.proto:1163

  实时获取对应信息

  • int64 total = 1

    总数

  • repeated AbnormalLogInfo list = 2

• rpc eventLogIndex (EventLogIndexReq, EventLogIndexResp)

  dm.proto:337

  获取设备数据信息

  message EventLogIndexReq

  dm.proto:1013

  获取对应日志信息

  • optional PageInfo 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 EventLogIndexResp

  dm.proto:1034

  获取对应日志信息

  • int64 total = 1

    总数

  • repeated EventLogInfo list = 2

• rpc gatewayCanBindIndex (GatewayCanBindIndexReq, GatewayCanBindIndexResp)

  dm.proto:342

  获取网关可以绑定的子设备列表

  message GatewayCanBindIndexReq

  dm.proto:1414

  • optional DeviceCore gateway = 1

  message GatewayCanBindIndexResp

  dm.proto:1418

  • repeated DeviceCore subDevices = 1

  • int64 updatedTime = 2

    更新时间

• rpc hubLogIndex (HubLogIndexReq, HubLogIndexResp)

  dm.proto:321

  获取设备调试信息记录登入登出,操作

  message HubLogIndexReq

  dm.proto:1040

  实时获取对应信息

  • string productID = 1

    产品id

  • string deviceName = 2

    设备名

  • int64 timeStart = 3

    获取时间的开始(毫秒时间戳)

  • int64 timeEnd = 4

    时间的结束(毫秒时间戳)

  • optional PageInfo page = 5

    分页信息

  • repeated string actions = 6

    过滤操作类型 connected:上线 disconnected:下线 property:属性 event:事件 action:操作 thing:物模型提交的操作为匹配的日志

  • repeated string topics = 7

    过滤主题

  • string content = 8

    过滤内容

  • string requestID = 9

    过滤请求ID

  message HubLogIndexResp

  dm.proto:1053

  实时获取对应信息

  • int64 total = 1

    总数

  • repeated HubLogInfo list = 2

• rpc propertyAggIndex (PropertyAggIndexReq, PropertyAggIndexResp)

  dm.proto:334

  message PropertyAggIndexReq

  dm.proto:929

  • string tenantCode = 21

    租户号,只有管理员有权限

  • int64 projectID = 20

    只有管理员有权限

  • int64 areaID = 14

    只有管理员有权限

  • string areaIDPath = 15

    只有管理员有权限

  • repeated int64 areaIDs = 16

    只有管理员有权限

  • int64 productCategoryID = 17

    产品品类id

  • map<string, IDsInfo> BelongGroup = 18

    key是group的purpose, value是里面包含的分组id

  • string deviceName = 2

    设备ID

  • repeated string deviceNames = 3

  • string productID = 4

    产品id (必填)

  • int64 timeStart = 6

    获取时间的开始(毫秒时间戳)

  • int64 timeEnd = 7

    时间的结束(毫秒时间戳)

  • int64 interval = 8

    间隔 如果这个值不为零值 则时间的开始和结束必须有效及聚合函数不应该为空

  • string intervalUnit = 12

    间隔单位 a (毫秒,默认), d (天), h (小时), m (分钟), n (月), s (秒), u (微秒), w (周), y (年)

  • int64 order = 11

    时间排序 1:aes(默认,从久到近排序) 2:desc(时间从近到久排序)

  • string partitionBy = 13

    切分数据,可以填写deviceName

  • repeated PropertyAgg aggs = 10

    聚合参数

  message PropertyAggIndexResp

  dm.proto:950

  获取对应日志信息

  • repeated PropertyAggResp list = 2

• rpc propertyLogIndex (PropertyLogIndexReq, PropertyLogIndexResp)

  dm.proto:333

  获取设备数据信息

  message PropertyLogIndexReq

  dm.proto:888

  获取对应日志信息

  • optional PageInfo page = 1

    使用了聚合函数及间隔的时候无效

  • string tenantCode = 21

    租户号,只有管理员有权限

  • int64 projectID = 20

    只有管理员有权限

  • int64 areaID = 14

    只有管理员有权限

  • string areaIDPath = 15

    只有管理员有权限

  • repeated int64 areaIDs = 16

    只有管理员有权限

  • int64 productCategoryID = 17

    产品品类id

  • map<string, IDsInfo> BelongGroup = 18

    key是group的purpose, value是里面包含的分组id

  • 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

    时间排序 1:aes(默认,从久到近排序) 2:desc(时间从近到久排序)

  • string partitionBy = 13

    切分数据,可以填写deviceName

  • bool noFirstTs = 22

    时间戳填充不填充最早的值,聚合模式使用

• rpc propertyLogLatestIndex (PropertyLogLatestIndexReq, PropertyLogIndexResp)

  dm.proto:329

  获取设备数据信息

• rpc propertyLogLatestIndex2 (PropertyLogLatestIndex2Req, PropertyLogIndexResp)

  dm.proto:330

  message PropertyLogLatestIndex2Req

  dm.proto:983

  • repeated DeviceData devices = 4

• rpc sdkLogIndex (SdkLogIndexReq, SdkLogIndexResp)

  dm.proto:319

  获取设备sdk调试日志

  message SdkLogIndexReq

  dm.proto:1180

  获取sdk调试日志信息

  • string productID = 1

    产品id

  • string deviceName = 2

    设备名

  • int64 timeStart = 3

    获取时间的开始

  • int64 timeEnd = 4

    时间的结束

  • int64 logLevel = 5

    日志等级

  • optional PageInfo page = 6

    分页信息 只获取一个则不填

  message SdkLogIndexResp

  dm.proto:1189

  sdk调试日志信息

  • int64 total = 1

    总数

  • repeated SdkLogInfo list = 2

• rpc sendLogIndex (SendLogIndexReq, SendLogIndexResp)

  dm.proto:322

  message SendLogIndexReq

  dm.proto:1102

  实时获取对应信息

  • int64 projectID = 13

    只有管理员有权限

  • int64 areaID = 14

    只有管理员有权限

  • string areaIDPath = 15

    只有管理员有权限

  • repeated int64 areaIDs = 16

    只有管理员有权限

  • map<string, IDsInfo> BelongGroup = 17

    key是group的purpose, value是里面包含的分组id

  • int64 productCategoryID = 11

    产品品类id

  • string productID = 1

    产品id

  • string deviceName = 2

    设备名

  • int64 timeStart = 3

    获取时间的开始(毫秒时间戳)

  • int64 timeEnd = 4

    时间的结束(毫秒时间戳)

  • optional PageInfo page = 5

    分页信息

  • int64 userID = 9

  • repeated string actions = 10

  • int64 resultCode = 12

    请求结果状态,200为成功

  • string dataID = 8

    identify

  • repeated string dataIDs = 7

  message SendLogIndexResp

  dm.proto:1123

  实时获取对应信息

  • int64 total = 1

    总数

  • repeated SendLogInfo list = 2

• rpc shadowIndex (PropertyLogLatestIndexReq, ShadowIndexResp)

  dm.proto:339

  获取设备影子列表

  message ShadowIndexResp

  dm.proto:837

  • repeated ShadowIndex list = 1

• rpc statusLogIndex (StatusLogIndexReq, StatusLogIndexResp)

  dm.proto:323

  message StatusLogIndexReq

  dm.proto:1075

  实时获取对应信息

  • string productID = 1

    产品id

  • string deviceName = 2

    设备名

  • int64 timeStart = 3

    获取时间的开始(毫秒时间戳)

  • int64 timeEnd = 4

    时间的结束(毫秒时间戳)

  • optional PageInfo page = 5

    分页信息

  • int64 status = 9

    在线状态

  message StatusLogIndexResp

  dm.proto:1085

  实时获取对应信息

  • int64 total = 1

    总数

  • repeated StatusLogInfo list = 2

新的ota功能实现

• rpc otaFirmwareDeviceCancel (OtaFirmwareDeviceCancelReq, Empty)

  dm.proto:402

  取消指定批次下的设备升级作业

  message OtaFirmwareDeviceCancelReq

  dm.proto:2458

  • int64 firmwareID = 1

  • int64 jobID = 2

  • repeated string deviceNames = 3

• rpc otaFirmwareDeviceConfirm (OtaFirmwareDeviceConfirmReq, Empty)

  dm.proto:406

  app确认设备升级

  message OtaFirmwareDeviceConfirmReq

  dm.proto:2471

  • string productID = 1

  • string deviceName = 2

• rpc otaFirmwareDeviceIndex (OtaFirmwareDeviceIndexReq, OtaFirmwareDeviceIndexResp)

  dm.proto:400

  查询指定升级批次下的设备升级作业列表

  message OtaFirmwareDeviceIndexReq

  dm.proto:2428

  • optional PageInfo 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 OtaFirmwareDeviceIndexResp

  dm.proto:2453

  • repeated OtaFirmwareDeviceInfo list = 1

  • int64 total = 2

• rpc otaFirmwareDeviceRetry (OtaFirmwareDeviceRetryReq, Empty)

  dm.proto:404

  重新升级指定批次下升级失败或升级取消的设备升级作业

  message OtaFirmwareDeviceRetryReq

  dm.proto:2465

  • int64 firmwareID = 1

  • int64 jobID = 2

  • repeated string deviceNames = 3

• rpc otaFirmwareInfoCreate (OtaFirmwareInfoCreateReq, WithID)

  dm.proto:380

  添加升级包

  message OtaFirmwareInfoCreateReq

  dm.proto:2249

  • string 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 google.protobuf.StringValue extra = 14

    自定义数据

  • repeated string filePaths = 15

  • string moduleCode = 16

    模块编码

• rpc otaFirmwareInfoDelete (WithID, Empty)

  dm.proto:384

  删除升级包

• rpc otaFirmwareInfoIndex (OtaFirmwareInfoIndexReq, OtaFirmwareInfoIndexResp)

  dm.proto:386

  升级包列表

  message OtaFirmwareInfoIndexReq

  dm.proto:2287

  • optional PageInfo page = 1

    分页

  • string productID = 2

    产品id

  • string name = 3

    产品名称

  message OtaFirmwareInfoIndexResp

  dm.proto:2293

  • repeated OtaFirmwareInfo list = 1

  • int64 total = 2

• rpc otaFirmwareInfoRead (WithID, OtaFirmwareInfo)

  dm.proto:388

  查询升级包

• rpc otaFirmwareInfoUpdate (OtaFirmwareInfoUpdateReq, WithID)

  dm.proto:382

  修改升级包

  message OtaFirmwareInfoUpdateReq

  dm.proto:2278

  • int64 id = 1

    固件id

  • string name = 2

    固件升级包名称

  • string desc = 3

    文件描述

  • optional google.protobuf.StringValue extra = 14

    推送设备端的信息

• rpc otaFirmwareJobCreate (OtaFirmwareJobInfo, WithID)

  dm.proto:392

  创建静态升级批次

• rpc otaFirmwareJobIndex (OtaFirmwareJobIndexReq, OtaFirmwareJobIndexResp)

  dm.proto:394

  获取升级包下的升级任务批次列表

  message OtaFirmwareJobIndexReq

  dm.proto:2408

  • optional PageInfo page = 1

  • int64 firmwareID = 2

  • string productID = 3

  • string deviceName = 4

  message OtaFirmwareJobIndexResp

  dm.proto:2415

  • repeated OtaFirmwareJobInfo list = 1

  • int64 total = 2

• rpc otaFirmwareJobRead (WithID, OtaFirmwareJobInfo)

  dm.proto:396

  查询指定升级批次的详情

• rpc otaFirmwareJobUpdate (OtaFirmwareJobInfo, Empty)

  dm.proto:398

  取消动态升级策略

• rpc otaModuleInfoCreate (OtaModuleInfo, WithID)

  dm.proto:409

• rpc otaModuleInfoDelete (WithID, Empty)

  dm.proto:411

• rpc otaModuleInfoIndex (OtaModuleInfoIndexReq, OtaModuleInfoIndexResp)

  dm.proto:412

  message OtaModuleInfoIndexReq

  dm.proto:500

  • optional PageInfo page = 1

  • string name = 2

  • string productID = 3

  message OtaModuleInfoIndexResp

  dm.proto:506

  • int64 total = 1

  • repeated OtaModuleInfo list = 2

• rpc otaModuleInfoRead (WithIDCode, OtaModuleInfo)

  dm.proto:413

• rpc otaModuleInfoUpdate (OtaModuleInfo, Empty)

  dm.proto:410

产品管理

• rpc productCategoryCreate (ProductCategory, WithID)

  dm.proto:203

  新增产品

• rpc productCategoryDelete (WithID, Empty)

  dm.proto:207

  删除产品

• rpc productCategoryIndex (ProductCategoryIndexReq, ProductCategoryIndexResp)

  dm.proto:209

  获取产品信息列表

  message ProductCategoryIndexReq

  dm.proto:682

  • optional PageInfo page = 1

    分页信息 只获取一个则不填

  • string name = 2

    过滤名字

  • int64 parentID = 3

  • repeated int64 ids = 4

  • int64 projectID = 5

    项目id,只获取项目下有设备的

  message ProductCategoryIndexResp

  dm.proto:690

  • repeated ProductCategory list = 1

    产品信息

  • int64 total = 2

    总数(只有分页的时候会返回)

• rpc productCategoryMultiExport (ProductCategoryExportReq, ProductCategoryExportResp)

  dm.proto:223

  产品导出

  message ProductCategoryExportReq

  dm.proto:471

  • repeated int64 ids = 1

    产品导出的详情信息

  message ProductCategoryExportResp

  dm.proto:474

  • string categories = 1

    品类信息

• rpc productCategoryMultiImport (ProductCategoryImportReq, ImportResp)

  dm.proto:222

  产品导入

  message ProductCategoryImportReq

  dm.proto:467

  • string categories = 1

    品类信息

• rpc productCategoryRead (WithIDChildren, ProductCategory)

  dm.proto:211

  获取产品信息详情

  message WithIDChildren

  dm.proto:58

  • int64 id = 1

    id

  • bool withChildren = 2

• rpc productCategorySchemaIndex (ProductCategorySchemaIndexReq, ProductCategorySchemaIndexResp)

  dm.proto:213

  获取产品品类下的物模型列表,绑定的物模型会自动添加到该产品品类及子分类的产品中,并不支持删除

  message ProductCategorySchemaIndexReq

  dm.proto:672

  • int64 productCategoryID = 1

  • bool withFather = 8

    同时返回父节点的物模型

  message ProductCategorySchemaIndexResp

  dm.proto:668

  • repeated string identifiers = 5

    过滤标识符列表

• rpc productCategorySchemaMultiCreate (ProductCategorySchemaMultiSaveReq, Empty)

  dm.proto:215

• rpc productCategorySchemaMultiDelete (ProductCategorySchemaMultiSaveReq, Empty)

  dm.proto:216

• rpc productCategorySchemaMultiUpdate (ProductCategorySchemaMultiSaveReq, Empty)

  dm.proto:214

• rpc productCategoryUpdate (ProductCategory, Empty)

  dm.proto:205

  更新产品

• rpc productConfigUpdate (ProductConfig, Empty)

  dm.proto:179

  更新产品配置

  物模型管理

• rpc productCustomRead (ProductCustomReadReq, ProductCustom)

  dm.proto:197

  脚本管理

  message ProductCustomReadReq

  dm.proto:1353

  • string productID = 1

• rpc productCustomUpdate (ProductCustom, Empty)

  dm.proto:198

• rpc productInfoCreate (ProductInfo, Empty)

  dm.proto:169

  新增产品

• rpc productInfoDelete (ProductInfoDeleteReq, Empty)

  dm.proto:173

  删除产品

  message ProductInfoDeleteReq

  dm.proto:1631

  • string productID = 1

    产品id

• rpc productInfoIndex (ProductInfoIndexReq, ProductInfoIndexResp)

  dm.proto:175

  获取产品信息列表

  message ProductInfoIndexReq

  dm.proto:1641

  • optional PageInfo 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 ProductInfoIndexResp

  dm.proto:1665

  • repeated ProductInfo list = 1

    产品信息

  • int64 total = 2

    总数(只有分页的时候会返回)

• rpc productInfoMultiExport (ProductInfoExportReq, ProductInfoExportResp)

  dm.proto:220

  产品导出

  message ProductInfoExportReq

  dm.proto:460

  • repeated string productIDs = 1

  message ProductInfoExportResp

  dm.proto:463

  • string products = 2

    产品导出的信息

• rpc productInfoMultiImport (ProductInfoImportReq, ImportResp)

  dm.proto:219

  产品导入

  message ProductInfoImportReq

  dm.proto:449

  • string products = 2

    产品导出的信息

• rpc productInfoRead (ProductInfoReadReq, ProductInfo)

  dm.proto:177

  获取产品信息详情

  message ProductInfoReadReq

  dm.proto:1635

  • string productID = 1

    产品id

  • bool withProtocol = 2

  • bool withCategory = 3

• rpc productInfoUpdate (ProductInfo, Empty)

  dm.proto:171

  更新产品

• rpc productInit (ProductInitReq, Empty)

  dm.proto:166

  产品管理

  message ProductInitReq

  dm.proto:521

  • repeated string productIDs = 2

    repeated string initType =1;//thing:物模型

    产品id,不填初始化所有产品

• rpc productSchemaCreate (ProductSchemaCreateReq, Empty)

  dm.proto:184

  新增产品

  message ProductSchemaCreateReq

  dm.proto:1872

  • optional ProductSchemaInfo info = 1

    物模型信息

• rpc productSchemaDelete (ProductSchemaDeleteReq, Empty)

  dm.proto:188

  删除产品

  message ProductSchemaDeleteReq

  dm.proto:1876

  • string productID = 1

    产品id 如果为空返回所有产品的信息

  • string identifier = 2

    标识符

• rpc productSchemaIndex (ProductSchemaIndexReq, ProductSchemaIndexResp)

  dm.proto:190

  获取产品信息列表

  message ProductSchemaIndexReq

  dm.proto:1882

  • optional PageInfo 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 ProductSchemaIndexResp

  dm.proto:1898

  • repeated ProductSchemaInfo list = 1

  • int64 total = 2

    总数(只有分页的时候会返回)

• rpc productSchemaMultiCreate (ProductSchemaMultiCreateReq, Empty)

  dm.proto:186

  批量新增物模型,只新增没有的,已有的不处理

  message ProductSchemaMultiCreateReq

  dm.proto:1867

  • string productID = 1

  • repeated ProductSchemaInfo list = 2

    物模型信息

• rpc productSchemaTslImport (ProductSchemaTslImportReq, Empty)

  dm.proto:192

  删除产品

  message ProductSchemaTslImportReq

  dm.proto:1924

  • string productID = 1

    产品id

  • string tsl = 2

    物模型tsl

• rpc productSchemaTslRead (ProductSchemaTslReadReq, ProductSchemaTslReadResp)

  dm.proto:194

  获取产品信息列表

  message ProductSchemaTslReadReq

  dm.proto:1929

  • string productID = 1

    产品id

  message ProductSchemaTslReadResp

  dm.proto:1933

  • string tsl = 1

    物模型tsl

• rpc productSchemaUpdate (ProductSchemaUpdateReq, Empty)

  dm.proto:182

  更新产品物模型

  message ProductSchemaUpdateReq

  dm.proto:1862

  • optional ProductSchemaInfo info = 1

    物模型信息

• rpc protocolInfoCreate (ProtocolInfo, WithID)

  dm.proto:248

  协议创建

• rpc protocolInfoDelete (WithID, Empty)

  dm.proto:252

  协议删除

• rpc protocolInfoIndex (ProtocolInfoIndexReq, ProtocolInfoIndexResp)

  dm.proto:244

  协议列表

  message ProtocolInfoIndexReq

  dm.proto:770

  • optional PageInfo 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 ProtocolInfoIndexResp

  dm.proto:780

  • repeated ProtocolInfo list = 1

  • int64 total = 2

• rpc protocolInfoRead (WithIDCode, ProtocolInfo)

  dm.proto:246

  协议详情

• rpc protocolInfoUpdate (ProtocolInfo, Empty)

  dm.proto:250

  协议更新

• rpc protocolScriptCreate (ProtocolScript, WithID)

  dm.proto:264

  协议创建

• rpc protocolScriptDebug (ProtocolScriptDebugReq, ProtocolScriptDebugResp)

  dm.proto:270

  message ProtocolScriptDebugReq

  dm.proto:695

  • int64 triggerDir = 2

    1:up 2:down

  • int64 triggerTimer = 3

    收到前处理1:before 2:after

  • string script = 6

    脚本内容

  • optional PublishMsg req = 8

    请求

  • optional PublishMsg resp = 9

    回复

  message ProtocolScriptDebugResp

  dm.proto:703

  • optional PublishMsg out = 1

  • repeated string logs = 2

• rpc protocolScriptDelete (WithID, Empty)

  dm.proto:268

  协议删除

• rpc protocolScriptDeviceCreate (ProtocolScriptDevice, WithID)

  dm.proto:278

  协议创建

• rpc protocolScriptDeviceDelete (WithID, Empty)

  dm.proto:282

  协议删除

• rpc protocolScriptDeviceIndex (ProtocolScriptDeviceIndexReq, ProtocolScriptDeviceIndexResp)

  dm.proto:274

  协议列表

  message ProtocolScriptDeviceIndexReq

  dm.proto:752

  • optional PageInfo 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 ProtocolScriptDeviceIndexResp

  dm.proto:764

  • repeated ProtocolScriptDevice list = 1

  • int64 total = 2

• rpc protocolScriptDeviceRead (WithID, ProtocolScriptDevice)

  dm.proto:276

  协议详情

• rpc protocolScriptDeviceUpdate (ProtocolScriptDevice, Empty)

  dm.proto:280

  协议更新

• rpc protocolScriptIndex (ProtocolScriptIndexReq, ProtocolScriptIndexResp)

  dm.proto:260

  协议列表

  message ProtocolScriptIndexReq

  dm.proto:721

  • optional PageInfo 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 ProtocolScriptIndexResp

  dm.proto:732

  • repeated ProtocolScript list = 1

  • int64 total = 2

• rpc protocolScriptMultiExport (ProtocolScriptExportReq, ProtocolScriptExportResp)

  dm.proto:285

  产品导出

  message ProtocolScriptExportReq

  dm.proto:493

  • repeated int64 ids = 5

    标识符列表

  message ProtocolScriptExportResp

  dm.proto:496

  • string scripts = 1

    脚本信息列表

• rpc protocolScriptMultiImport (ProtocolScriptImportReq, ImportResp)

  dm.proto:284

  产品导入

  message ProtocolScriptImportReq

  dm.proto:489

  • string scripts = 1

    脚本信息列表

• rpc protocolScriptRead (WithID, ProtocolScript)

  dm.proto:262

  协议详情

• rpc protocolScriptUpdate (ProtocolScript, Empty)

  dm.proto:266

  协议更新

• rpc protocolServiceDelete (WithID, Empty)

  dm.proto:256

• rpc protocolServiceIndex (ProtocolServiceIndexReq, ProtocolServiceIndexResp)

  dm.proto:257

  message ProtocolServiceIndexReq

  dm.proto:785

  • optional PageInfo page = 1

  • string code = 2

    iThings,iThings-thingsboard,wumei,aliyun,huaweiyun,tuya

  message ProtocolServiceIndexResp

  dm.proto:790

  • repeated ProtocolService list = 1

  • int64 total = 2

• rpc protocolServiceUpdate (ProtocolService, Empty)

  dm.proto:255

  更新服务状态,只给服务调用

• rpc RemoteConfigCreate (RemoteConfigCreateReq, Empty)

  dm.proto:310

  message RemoteConfigCreateReq

  dm.proto:1326

  • string productID = 1

  • string content = 2

• rpc RemoteConfigIndex (RemoteConfigIndexReq, RemoteConfigIndexResp)

  dm.proto:311

  message RemoteConfigIndexReq

  dm.proto:1331

  • optional PageInfo page = 1

  • string productID = 2

  message RemoteConfigIndexResp

  dm.proto:1336

  • repeated ProductRemoteConfig list = 1

  • int64 total = 2

• rpc RemoteConfigLastRead (RemoteConfigLastReadReq, RemoteConfigLastReadResp)

  dm.proto:313

  message RemoteConfigLastReadReq

  dm.proto:1345

  • string productID = 1

  message RemoteConfigLastReadResp

  dm.proto:1349

  • optional ProductRemoteConfig info = 1

• rpc RemoteConfigPushAll (RemoteConfigPushAllReq, Empty)

  dm.proto:312

  message RemoteConfigPushAllReq

  dm.proto:1341

  • string productID = 1

公共物模型管理

• rpc commonSchemaCreate (CommonSchemaCreateReq, Empty)

  dm.proto:232

  新增产品

  message CommonSchemaCreateReq

  dm.proto:1805

  • optional CommonSchemaInfo info = 1

    物模型信息

• rpc commonSchemaDelete (WithID, Empty)

  dm.proto:234

  删除产品

• rpc commonSchemaIndex (CommonSchemaIndexReq, CommonSchemaIndexResp)

  dm.proto:236

  获取产品信息列表

  message CommonSchemaIndexReq

  dm.proto:1811

  • optional PageInfo 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 CommonSchemaIndexResp

  dm.proto:1834

  • repeated CommonSchemaInfo list = 1

  • int64 total = 2

    总数(只有分页的时候会返回)

• rpc commonSchemaInit (Empty, Empty)

  dm.proto:228

• rpc commonSchemaMultiExport (CommonSchemaExportReq, CommonSchemaExportResp)

  dm.proto:239

  产品导出

  message CommonSchemaExportReq

  dm.proto:482

  • repeated string identifiers = 5

    标识符列表

  message CommonSchemaExportResp

  dm.proto:485

  • string schemas = 1

    品类信息

• rpc commonSchemaMultiImport (CommonSchemaImportReq, ImportResp)

  dm.proto:238

  产品导入

  message CommonSchemaImportReq

  dm.proto:478

  • string schemas = 1

    品类信息

• rpc commonSchemaUpdate (CommonSchemaUpdateReq, Empty)

  dm.proto:230

  更新产品物模型

  message CommonSchemaUpdateReq

  dm.proto:1798

  • optional CommonSchemaInfo info = 1

    物模型信息

• rpc userDeivceShareMultiAccept (UserDeviceShareMultiAcceptReq, Empty)

  dm.proto:445

  接受批量分享的设备

  message UserDeviceShareMultiAcceptReq

  dm.proto:641

  • string shareToken = 1

  • int64 sharedUserID = 3

    分享的对象

  • string sharedUserAccount = 2

    分享的账号(只读)

  • repeated DeviceCore devices = 4

• rpc userDeivceShareMultiIndex (UserDeviceShareMultiToken, UserDeviceShareMultiInfo)

  dm.proto:443

  扫码后获取设备列表

• rpc userDeviceCollectIndex (Empty, UserDeviceCollectSave)

  dm.proto:421

• rpc userDeviceCollectMultiCreate (UserDeviceCollectSave, Empty)

  dm.proto:419

  用户收藏的设备

• rpc userDeviceCollectMultiDelete (UserDeviceCollectSave, Empty)

  dm.proto:420

• rpc userDeviceShareCreate (UserDeviceShareInfo, WithID)

  dm.proto:424

  分享设备

• rpc userDeviceShareDelete (UserDeviceShareReadReq, Empty)

  dm.proto:428

  取消分享设备

• rpc userDeviceShareIndex (UserDeviceShareIndexReq, UserDeviceShareIndexResp)

  dm.proto:432

  获取设备分享列表(只有设备的所有者才能获取)

  message UserDeviceShareIndexReq

  dm.proto:583

  • optional PageInfo page = 1

  • optional DeviceCore device = 2

    设备信息

  message UserDeviceShareIndexResp

  dm.proto:588

  • repeated UserDeviceShareInfo list = 1

  • int64 total = 2

• rpc userDeviceShareMultiCreate (UserDeviceShareMultiInfo, UserDeviceShareMultiToken)

  dm.proto:441

  rpc userDeviceOtaGetVersion(UserDeviceOtaGetVersionReq)returns(userDeviceOtaGetVersionResp); 创建批量分享二维码，设备列表写入缓存

• rpc userDeviceShareMultiDelete (UserDeviceShareMultiDeleteReq, Empty)

  dm.proto:430

  取消分享设备

  message UserDeviceShareMultiDeleteReq

  dm.proto:594

  • repeated int64 ids = 1

  • int64 projectID = 2

    指定项目的情况下删除分享的所有设备

• rpc userDeviceShareRead (UserDeviceShareReadReq, UserDeviceShareInfo)

  dm.proto:434

  获取设备分享的详情

• rpc userDeviceShareUpdate (UserDeviceShareInfo, Empty)

  dm.proto:426

  更新权限

• rpc userDeviceTransfer (DeviceTransferReq, Empty)

  dm.proto:437

  转让设备

设备的日志数据

Used as request type in: DeviceMsg.abnormalLogCreate

Used as field type in: AbnormalLogIndexResp

• int64 timestamp = 1

  发生时间戳(毫秒时间戳)

• int64 action = 2

  触发1还是解除2

• string type = 4

  异常类型

• string productID = 5

• string deviceName = 6

• string Reason = 7

  原因

• string traceID = 9

  服务器端事务id

Used as response type in: DeviceInteract.actionRead, DeviceInteract.actionSend

• string msgToken = 1

  调用id

• string outputParams = 2

  输出参数 注意：此字段可能返回 null，表示取不到有效值。

• string msg = 3

  返回状态

• int64 code = 4

  设备返回状态码

Used in: CommonSchemaCreateReq, CommonSchemaIndexResp, CommonSchemaUpdateReq

• int64 id = 1

• int64 type = 2

  物模型类型 1:property属性 2:event事件 3:action行为

• string identifier = 4

  标识符

• optional google.protobuf.StringValue name = 5

  功能名称

• optional google.protobuf.StringValue desc = 6

  描述

• int64 required = 7

  是否必须 1:是 2:否

• int64 isCanSceneLinkage = 8

  是否支持场景联动控制

• int64 funcGroup = 14

  功能分类: 1:普通功能 2:系统功能

• int64 userPerm = 15

  用户权限操作: 1:r(只读) 3:rw(可读可写)

• int64 recordMode = 10

  1(默认) 记录历史记录 2 只记录差异值 3 不记录历史记录

• int64 isPassword = 17

  是否是密码类型,密码类型需要加掩码

• optional google.protobuf.StringValue affordance = 11

  各功能类型的详细参数定义

• string extendConfig = 12

  拓展参数

• int64 order = 13

  排序

• int64 controlMode = 16

  控制模式: 1: 可以群控,可以单控 2:只能单控

• repeated ProductCategory productCategories = 3

  绑定的产品品类(如果绑定了,则该品类下的产品会自动新增并不允许删除)

Used in: DeviceInfoIndexReq, DeviceInfoMultiUpdateReq

• string CmpType = 1

  "=":相等 "!=":不相等 ">":大于">=":大于等于"<":小于"<=":小于等于 "like":模糊查询

• int64 value = 2

  值

Used in: DeviceInfoIndexReq

• string CmpType = 1

  "=":相等 "!=":不相等 ">":大于">=":大于等于"<":小于"<=":小于等于 "like":模糊查询

• string value = 2

  值

Used in: ProductCustom

• string topic = 1

  自定义主题需要以$custom 并包含设备名称{deviceName}及产品名称{productID}

• int64 direction = 2

  1:上行 2:下行 3:双向

Used in: ProductConfig

• string tenantCode = 1

  设备创建默认分配给的租户

• int64 projectID = 2

  设备创建默认分配给的项目

• int64 areaID = 3

  设备创建默认分配给的区域ID

• int64 deptID = 4

  设备创建默认分配给的部门

Used as response type in: DeviceManage.deviceBindTokenCreate, DeviceManage.deviceBindTokenRead

• string token = 1

  配网token

• int64 status = 2

  token状态 1:初始状态 2: 设备已上报

Used in: DeviceGatewayIndexReq, DeviceGatewayIndexResp, DeviceGatewayMultiCreateReq, DeviceGatewayMultiSaveReq, DeviceInfoBindReq, DeviceInfoCanBindReq, DeviceInfoIndexReq, DeviceInfoMultiBindReq, DeviceInfoMultiUpdateReq, DeviceMoveReq, DeviceProfile, DeviceProfileIndexReq, DeviceProfileReadReq, DeviceResetReq, DeviceTransferReq, GatewayCanBindIndexReq, GatewayCanBindIndexResp, GatewayNotifyBindSendReq, GroupDeviceMultiDeleteReq, GroupDeviceMultiSaveReq, GroupInfo, GroupInfoIndexReq, PropertyControlMultiSendReq, PropertyGetReportMultiSendReq, UserDeviceCollectSave, UserDeviceShareIndexReq, UserDeviceShareInfo, UserDeviceShareMultiAcceptReq, UserDeviceShareReadReq, deviceOnlineMultiFix

• string productID = 1

  产品id

• string deviceName = 2

  设备名称

Used in: DeviceCountResp

• int64 rangeID = 1

• map<string, int64> count = 2

Used in: PropertyLogLatestIndex2Req

• string productID = 1

  产品id

• string deviceName = 2

  设备名称

• string dataID = 3

  属性id

Used in: DeviceInfoMultiBindResp

• string productID = 1

  产品id

• string deviceName = 2

  设备名称

• int64 code = 3

• string msg = 4

Used in: DeviceGatewayMultiCreateReq

• string productID = 1

  产品id

• string deviceName = 2

  设备id

• string deviceAlias = 4

  设备名称,如果填写了则会更新设备的名称

• optional DeviceGatewaySign sign = 3

  签名

Used as request type in: DeviceManage.deviceGatewayMultiDelete, DeviceManage.deviceGatewayMultiUpdate

• optional DeviceCore gateway = 1

• bool isNotNotify = 2

  不通知网关设备状态做了调整

• repeated DeviceCore list = 3

Used in: DeviceGatewayBindDevice

• 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

Used 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

Used as request type in: DeviceManage.deviceInfoCreate, DeviceManage.deviceInfoUpdate

Used as response type in: DeviceManage.deviceInfoRead

Used as field type in: DeviceInfoIndexResp, ProtocolScriptDevice

• 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 google.protobuf.StringValue version = 11

  固件版本 读写

• string hardInfo = 12

  模组硬件型号 只读

• string softInfo = 13

  模组软件版本 只读

• optional Point Position = 14

  设备定位,默认百度坐标系

• optional google.protobuf.StringValue address = 15

  所在地址 读写

• optional google.protobuf.StringValue 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 lastOffline = 62

  最后离线时间 只读

• int64 logLevel = 20

  日志级别:1)关闭 2)错误 3)告警 4)信息 5)调试 读写

• optional google.protobuf.StringValue deviceAlias = 21

  设备别名 读写

• int64 mobileOperator = 22

  移动运营商:1)移动 2)联通 3)电信 4)广电

• optional google.protobuf.StringValue phone = 23

  手机号

• optional google.protobuf.StringValue iccid = 24

  SIM卡卡号

• map<string, string> schemaAlias = 25

  设备物模型别名,如果是结构体类型则key为xxx.xxx

• optional google.protobuf.Int64Value 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 IDPathWithUpdate distributor = 36

  过滤分销商的数据

• optional google.protobuf.Int64Value 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,只读

• string lastLocalIp = 63

  最后的局域网ip,只读

• optional google.protobuf.StringValue desc = 47

• optional IDPathWithUpdate dept = 52

  过滤分销商的数据

• optional DeviceInfo Gateway = 46

  子设备绑定的网关

• int64 sort = 53

  排序

• string groupPurpose = 58

  更新的时候使用,将设备该用途下的分组进行更新

• repeated int64 groupIDs = 59

  如果要更新分组,必须填写groupPurpose

• map<string, IDsInfo> BelongGroup = 61

  key是group的purpose, value是里面包含的分组id

• string deviceImg = 54

  设备图片

• bool isUpdateDeviceImg = 55

  只有这个参数为true的时候才会更新设备图片,传参为图片的file path

• string file = 56

  设备文件

• bool isUpdateFile = 57

  只有这个参数为true的时候才会更新设备文件,传参为文件的file path

Used as response type in: DeviceManage.deviceModuleVersionRead

Used as field type in: DeviceModuleVersionIndexResp

• int64 id = 1

• string productID = 2

• string deviceName = 3

• string moduleCode = 4

• string version = 5

Used as request type in: DeviceManage.deviceProfileUpdate

Used as response type in: DeviceManage.deviceProfileRead

Used as field type in: DeviceProfileIndexResp

• optional DeviceCore device = 1

• string code = 2

• string params = 3

Used as request type in: DeviceManage.deviceProfileDelete, DeviceManage.deviceProfileRead

• optional DeviceCore device = 1

• string code = 2

Used as request type in: DeviceManage.deviceSchemaCreate, DeviceManage.deviceSchemaUpdate

Used as field type in: DeviceSchemaIndexResp, DeviceSchemaMultiCreateReq

• 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 google.protobuf.StringValue name = 5

  功能名称

• optional google.protobuf.StringValue 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 recordMode = 10

  1(默认) 记录历史记录 2 只记录差异值 3 不记录历史记录

• int64 isPassword = 18

  是否是密码类型,密码类型需要加掩码

• optional google.protobuf.StringValue affordance = 11

  各功能类型的详细参数定义

• string extendConfig = 12

  拓展参数

• int64 order = 13

  排序

Used in: UserDeviceShareMultiInfo

• string productID = 1

  产品id

• string productName = 4

  产品名称 只读

• string deviceName = 2

  设备名称

• string productImg = 3

  产品图片

• optional google.protobuf.StringValue deviceAlias = 5

  设备别名 读写

Used as request type in: DeviceManage.deviceTransfer, userDevice.userDeviceTransfer

• optional DeviceCore device = 1

  设备信息

• repeated DeviceCore 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否

Used 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.protocolInfoDelete, ProtocolManage.protocolInfoUpdate, ProtocolManage.protocolScriptDelete, ProtocolManage.protocolScriptDeviceDelete, ProtocolManage.protocolScriptDeviceUpdate, ProtocolManage.protocolScriptUpdate, 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)

设备的日志数据

Used in: EventLogIndexResp

• int64 timestamp = 1

  发生时间戳(毫秒时间戳)

• string type = 2

  事件类型: 信息:info 告警alert 故障:fault

• string dataID = 3

  属性id

• string params = 4

  获取到的值

• string deviceName = 5

  设备名(不填获取产品下所有设备)

• string path = 1

  文件的路径

• bool isUpdate = 2

  如果要更新该文件,则需要将该参数置为true

下面是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 google.protobuf.StringValue desc = 8

  描述

• optional google.protobuf.StringValue extData = 9

  自定义数据

• repeated OtaFirmwareFile files = 10

  产品信息

Used in: OtaFirmwareInfo

• string name = 1

• int64 size = 2

• string filePath = 3

• string signature = 4

• string fileMd5 = 5

Used in: FirmwareInfoIndexResp

• 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 google.protobuf.StringValue desc = 9

  描述

• optional google.protobuf.StringValue extData = 10

  自定义数据

• repeated OtaFirmwareFile files = 11

  产品信息

• int64 firmwareID = 1

• repeated string paths = 1

• optional PageInfo page = 1

  分页信息 只获取一个则不填

• int64 firmwareID = 2

• string productID = 3

• repeated FirmwareInfo list = 1

  固件信息

• int64 total = 2

  总数(只有分页的时候会返回)

• int64 firmwareID = 1

• 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

• optional google.protobuf.StringValue desc = 10

  描述

• optional google.protobuf.StringValue extData = 11

  自定义数据

• repeated OtaFirmwareFileResp files = 12

  产品信息

• int64 firmwareID = 1

• int64 id = 1

• int64 parentID = 2

• string name = 4

Used as request type in: DeviceGroup.groupDeviceMultiCreate, DeviceGroup.groupDeviceMultiUpdate

• int64 groupID = 1

• repeated DeviceCore list = 2

Used as request type in: DeviceGroup.groupInfoCreate, DeviceGroup.groupInfoUpdate

Used as response type in: DeviceGroup.groupInfoRead

Used as field type in: GroupInfoIndexResp, GroupInfoMultiCreateReq

• string purpose = 15

  用途 不填默认为default

• int64 areaID = 10

  分组可以属于某个区域下

• int64 projectID = 3

• int64 id = 1

• int64 parentID = 2

• string idPath = 17

• string name = 4

• string desc = 5

• int64 createdTime = 6

• map<string, string> tags = 7

• string productID = 8

• string productName = 9

• repeated DeviceCore devices = 11

• int64 deviceCount = 12

• int64 isLeaf = 13

• map<string, string> files = 16

  key 是用途, value是 是文件的路径,如果要更新该文件, 传filePath即可

• repeated GroupInfo children = 14

  DeviceInfoCount deviceInfoCount =11;

• string purpose = 6

  用途 不填默认为default

• int64 areaID = 5

  分组可以属于某个区域下

• string name = 1

• int64 parentID = 2

• string productID = 3

• string desc = 4

• int64 id = 1

• string name = 2

• string desc = 3

• map<string, string> tags = 4

• string productID = 5

设备的日志数据

Used in: HubLogIndexResp

• 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

  返回的内容

Used in: DeviceInfoIndexReq, DeviceInfoMultiUpdateReq

• int64 id = 1

• string idPath = 2

• int64 noParentID = 3

Used in: DeviceInfo

• int64 id = 1

• string idPath = 2

• int64 updatedTime = 3

Used in: AbnormalLogIndexReq, DeviceInfo, PropertyAggIndexReq, PropertyAggResp, PropertyLogIndexReq, PropertyLogInfo, SendLogIndexReq

• repeated int64 ids = 1

• repeated string idPaths = 2

Used as response type in: ProductManage.productCategoryMultiImport, ProductManage.productInfoMultiImport, ProtocolManage.protocolScriptMultiImport, SchemaManage.commonSchemaMultiImport

• int64 total = 1

  导入总接口数

• int64 errCount = 2

  失败数

• int64 ignoreCount = 3

  忽略数

• int64 succCount = 4

  成功数

Used in: OtaFirmwareDeviceIndexResp

• 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

  只读 设备是否在线

Used in: Firmware, FirmwareInfo

• string filePath = 1

• string name = 2

• optional PageInfo page = 1

• int64 firmwareID = 2

• optional google.protobuf.Int64Value size = 3

• repeated OtaFirmwareFileInfo list = 1

• int64 total = 2

Used in: OtaFirmwareFileIndexResp

• 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

• int64 fileID = 1

• string name = 2

• string host = 3

• string filePath = 4

• int64 size = 5

• string storage = 6

• string signMethod = 7

• string signature = 8

Used in: FirmwareInfoReadResp

• int64 fileID = 1

• string name = 2

• string host = 3

• string filePath = 4

• int64 size = 5

• string storage = 6

• string signature = 7

  string signMethod = 7;

Used as response type in: OtaManage.otaFirmwareInfoRead

Used as field type in: OtaFirmwareInfoIndexResp

• 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 FirmwareFile fileList = 11

  文件列表

• int64 isDiff = 12

  整包or差包

• int64 isNeedToVerify = 13

  是否需要验证

• string moduleCode = 14

  模块编码

Used as request type in: OtaManage.otaFirmwareJobCreate, OtaManage.otaFirmwareJobUpdate

Used as response type in: OtaManage.otaFirmwareJobRead

Used as field type in: OtaFirmwareJobIndexResp

• 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 OtaJobDynamicInfo dynamic = 15

• optional OtaJobStaticInfo static = 16

• string target = 17

  分组升级和区域升级填写对应的id

• repeated string tenantCodes = 18

  指定租户

• int64 createdTime = 19