Documentation ¶
Index ¶
- type AlarmInfo
- type AlarmInfoIndexReq
- type AlarmInfoIndexResp
- type AlarmNotify
- type AlarmRecord
- type AlarmRecordDealReq
- type AlarmRecordIndexReq
- type AlarmRecordIndexResp
- type AlarmSceneDeleteReq
- type AlarmSceneIndexReq
- type AlarmSceneIndexResp
- type AlarmSceneMultiSaveReq
- type AreaInfo
- type CodeReq
- type CommonResp
- type CommonSchemaCreateReq
- type CommonSchemaDeleteReq
- type CommonSchemaIndexReq
- type CommonSchemaIndexResp
- type CommonSchemaInfo
- type CommonSchemaUpdateReq
- type CompareInt64
- type DateRange
- type DeviceAuth5AccessReq
- type DeviceAuth5AccessResp
- type DeviceAuth5LoginReq
- type DeviceAuth5LoginResp
- type DeviceAuthAccessReq
- type DeviceAuthLoginReq
- type DeviceAuthRootCheckReq
- type DeviceCore
- type DeviceCountInfo
- type DeviceCountReq
- type DeviceCountResp
- type DeviceError
- type DeviceGateWayIndexReq
- type DeviceGateWayIndexResp
- type DeviceGateWayMultiCreateReq
- type DeviceGateWayMultiDeleteReq
- type DeviceInfo
- type DeviceInfoBindReq
- type DeviceInfoCanBindReq
- type DeviceInfoDeleteReq
- type DeviceInfoIndexReq
- type DeviceInfoIndexResp
- type DeviceInfoMultiBindReq
- type DeviceInfoMultiBindResp
- type DeviceInfoMultiUpdateReq
- type DeviceInfoReadReq
- type DeviceInfoSaveReq
- type DeviceInfoTransferReq
- type DeviceInfoWithProperty
- type DeviceInteractMultiSendPropertyMsg
- type DeviceInteractMultiSendPropertyReq
- type DeviceInteractMultiSendPropertyResp
- type DeviceInteractPropertyGetReportSendReq
- type DeviceInteractPropertyGetReportSendResp
- type DeviceInteractRespReadReq
- type DeviceInteractSendActionReq
- type DeviceInteractSendActionResp
- type DeviceInteractSendMsgReq
- type DeviceInteractSendPropertyReq
- type DeviceInteractSendPropertyResp
- type DeviceModuleVersion
- type DeviceModuleVersionIndexReq
- type DeviceModuleVersionIndexResp
- type DeviceModuleVersionReadReq
- type DeviceMsgEventLogIndexReq
- type DeviceMsgEventLogIndexResp
- type DeviceMsgEventLogInfo
- type DeviceMsgHubLogIndexReq
- type DeviceMsgHubLogIndexResp
- type DeviceMsgHubLogInfo
- type DeviceMsgPropertyIndexResp
- type DeviceMsgPropertyLogIndexReq
- type DeviceMsgPropertyLogInfo
- type DeviceMsgPropertyLogLatestIndexReq
- type DeviceMsgSdkIndexResp
- type DeviceMsgSdkInfo
- type DeviceMsgSdkLogIndexReq
- type DeviceMsgSendLogIndexReq
- type DeviceMsgSendLogIndexResp
- type DeviceMsgSendLogInfo
- type DeviceMsgShadowIndex
- type DeviceMsgShadowIndexResp
- type DeviceMsgStatusLogIndexReq
- type DeviceMsgStatusLogIndexResp
- type DeviceMsgStatusLogInfo
- type DeviceMultiImportErrdata
- type DeviceMultiImportReq
- type DeviceMultiImportResp
- type DeviceMultiImportRow
- type DeviceProfile
- type DeviceProfileIndexReq
- type DeviceProfileIndexResp
- type DeviceProfileReadReq
- type DeviceRegisterReq
- type DeviceRegisterResp
- type FirmwareCreateReq
- type FirmwareFile
- type FirmwareIndexReq
- type FirmwareIndexResp
- type FirmwareInfo
- type FirmwareUpdateReq
- type GatewayCanBindIndexReq
- type GatewayCanBindIndexResp
- type GatewayGetFoundReq
- type GatewayNotifyBindSendReq
- type GroupDeviceIndexReq
- type GroupDeviceIndexResp
- type GroupDeviceMultiDeleteReq
- type GroupDeviceMultiSaveReq
- type GroupInfo
- type GroupInfoIndexReq
- type GroupInfoIndexResp
- type IDPath
- type LogActionScene
- type OrderBy
- type OtaFirmwareCreateReq
- type OtaFirmwareDeviceCancelReq
- type OtaFirmwareDeviceConfirmReq
- type OtaFirmwareDeviceIndexReq
- type OtaFirmwareDeviceIndexResp
- type OtaFirmwareDeviceInfo
- type OtaFirmwareDeviceInfoResp
- type OtaFirmwareDeviceRetryReq
- type OtaFirmwareFile
- type OtaFirmwareFileInfo
- type OtaFirmwareIndex
- type OtaFirmwareIndexReq
- type OtaFirmwareIndexResp
- type OtaFirmwareInfo
- type OtaFirmwareInfoUpdateReq
- type OtaFirmwareJobDynamic
- type OtaFirmwareJobIndexReq
- type OtaFirmwareJobInfo
- type OtaFirmwareJobInfoIndexResp
- type OtaFirmwareJobStatic
- type OtaFirmwareReadResp
- type OtaModuleInfo
- type OtaModuleInfoIndexReq
- type OtaModuleInfoIndexResp
- type PageInfo
- type Point
- type ProductCategory
- type ProductCategoryIndexReq
- type ProductCategoryIndexResp
- type ProductCategorySchemaIndexReq
- type ProductCategorySchemaIndexResp
- type ProductCategorySchemaMultiSaveReq
- type ProductCustom
- type ProductCustomReadReq
- type ProductCustomTopic
- type ProductCustomUi
- type ProductInfo
- type ProductInfoDeleteReq
- type ProductInfoIndexReq
- type ProductInfoIndexResp
- type ProductInfoReadReq
- type ProductInitReq
- type ProductRemoteConfig
- type ProductRemoteConfigCreateReq
- type ProductRemoteConfigIndexReq
- type ProductRemoteConfigIndexResp
- type ProductRemoteConfigLastestReadReq
- type ProductRemoteConfigLastestReadResp
- type ProductRemoteConfigPushAllReq
- type ProductSchemaCreateReq
- type ProductSchemaDeleteReq
- type ProductSchemaIndexReq
- type ProductSchemaIndexResp
- type ProductSchemaInfo
- type ProductSchemaMultiCreateReq
- type ProductSchemaTslImportReq
- type ProductSchemaTslReadReq
- type ProductSchemaTslReadResp
- type ProductSchemaUpdateReq
- type ProtocolConfigField
- type ProtocolConfigInfo
- type ProtocolInfo
- type ProtocolInfoIndexReq
- type ProtocolInfoIndexResp
- type SceneFlowInfo
- type SceneInfo
- type SceneInfoCreateReq
- type SceneInfoIndexReq
- type SceneInfoIndexResp
- type SceneInfoUpdateReq
- type SceneLog
- type SceneLogAction
- type SceneLogActionAlarm
- type SceneLogActionDevice
- type SceneLogActionDeviceValue
- type SceneLogIndexReq
- type SceneLogIndexResp
- type SceneLogTrigger
- type SceneLogTriggerDevice
- type SchemaAction
- type SchemaDefine
- type SchemaEvent
- type SchemaParam
- type SchemaProperty
- type SchemaSpec
- type SendOption
- type SharePerm
- type SlotAreaSaveReq
- type SlotUserSubscribeReq
- type Tag
- type TimeRange
- type UserCollectDeviceInfo
- type UserCollectDeviceSave
- type UserCore
- type UserDeviceShareIndexReq
- type UserDeviceShareIndexResp
- type UserDeviceShareInfo
- type UserDeviceShareMultiDeleteReq
- type UserDeviceShareReadReq
- type WithID
- type WithIDChildren
- type WithIDOrCode
- type WithProfile
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlarmInfo ¶
type AlarmInfo struct { ID int64 `json:"id,optional"` Name string `json:"name,optional"` Status int64 `json:"status,optional"` //状态: 1启用 2禁用 Desc string `json:"desc,optional"` CreatedTime int64 `json:"createdTime,optional"` Level int64 `json:"level,optional"` //告警配置级别(1提醒 2一般 3严重 4紧急 5超紧急) UserIDs []int64 `json:"userIDs,string,optional"` //指定用户ID Accounts []string `json:"accounts,optional"` //账号 Notifies []*AlarmNotify `json:"notifies,optional"` //通知 SceneIDs []int64 `json:"sceneIDs,optional"` //绑定的场景列表 }
type AlarmInfoIndexReq ¶
type AlarmInfoIndexResp ¶
type AlarmNotify ¶
type AlarmRecord ¶
type AlarmRecord struct { ID int64 `json:"id,optional"` AlarmID int64 `json:"alarmID"` AlarmName string `json:"alarmName"` TriggerType int64 `json:"triggerType"` ProductID string `json:"productID"` //触发产品id DeviceName string `json:"deviceName"` //触发设备名称 SceneName string `json:"sceneName"` //场景名称 SceneID int64 `json:"sceneID"` //场景ID Level int64 `json:"level"` //告警配置级别(1提醒 2一般 3严重 4紧急 5超紧急) LastAlarm int64 `json:"lastAlarm"` //最新告警时间 CreatedTime int64 `json:"createdTime"` //创建时间 DealStatus int64 `json:"dealStatus"` //告警记录状态(1告警中 2忽略 3正在处理 4已处理) }
type AlarmRecordDealReq ¶
type AlarmRecordIndexReq ¶
type AlarmRecordIndexReq struct { AlarmID int64 `json:"alarmID,optional"` //告警记录ID Page *PageInfo `json:"page,optional"` //分页信息 只获取一个则不填 TimeRange *TimeRange `json:"timeRange,optional"` //时间范围 AlarmName string `json:"alarmName,optional"` DealStatus []int64 `json:"dealStatus"` //告警记录状态(1告警中 2忽略 3正在处理 4已处理) }
type AlarmRecordIndexResp ¶
type AlarmRecordIndexResp struct { List []*AlarmRecord `json:"list"` //告警信息 Total int64 `json:"total"` //总数(只有分页的时候会返回) }
type AlarmSceneDeleteReq ¶
type AlarmSceneIndexReq ¶
type AlarmSceneIndexReq struct {
AlarmID int64 `json:"alarmID"` //告警配置ID
}
type AlarmSceneIndexResp ¶
type AlarmSceneMultiSaveReq ¶
type CommonResp ¶
type CommonResp struct {
ID int64 `json:"id,optional"` // id
}
type CommonSchemaCreateReq ¶
type CommonSchemaCreateReq struct {
*CommonSchemaInfo
}
type CommonSchemaDeleteReq ¶
type CommonSchemaDeleteReq struct {
ID int64 `json:"id"` //产品id
}
type CommonSchemaIndexReq ¶
type CommonSchemaIndexReq struct { Page *PageInfo `json:"page,optional"` //分页信息,只获取一个则不填 Type int64 `json:"type,optional"` //物模型类型 1:property属性 2:event事件 3:action行为 Types []int64 `json:"types,optional"` Identifiers []string `json:"identifiers,optional"` //过滤标识符列表 ProductIDs []string `json:"productIDs,optional"` //提取产品共有的物模型 Name string `json:"name,optional"` ProductCategoryID int64 `json:"productCategoryID,optional"` ProductCategoryWithFather bool `json:"productCategoryWithFather,optional"` IsCanSceneLinkage int64 `json:"isCanSceneLinkage,optional"` //是否可以场景联动 FuncGroup int64 `json:"funcGroup,optional"` // 功能分类: 1:普通功能 2:系统功能 UserPerm int64 `json:"userPerm,optional"` //用户权限操作: 1:r(只读) 3:rw(可读可写) GroupID int64 `json:"groupID,optional"` GroupIDs []int64 `json:"groupIDs,optional"` AreaID int64 `json:"areaID,optional,string"` PropertyMode string `json:"propertyMode,optional"` //属性类型可用 读写类型: r(只读) rw(可读可写) ControlMode int64 `json:"controlMode,optional"` //控制模式: 1: 可以群控,可以单控 2:只能单控 ProductSceneMode string `json:"productSceneMode,optional"` //产品场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景) }
type CommonSchemaIndexResp ¶
type CommonSchemaIndexResp struct { List []*CommonSchemaInfo `json:"list"` //分页信息,只获取一个则不填 Total int64 `json:"total"` //总数(只有分页的时候会返回) }
type CommonSchemaInfo ¶
type CommonSchemaInfo struct { ID int64 `json:"id,optional"` //产品id Type int64 `json:"type,optional"` //物模型类型 1:property属性 2:event事件 3:action行为 Identifier string `json:"identifier,optional"` //标识符 ExtendConfig string `json:"extendConfig,optional"` //拓展参数 Name *string `json:"name,optional"` //功能名称 Desc *string `json:"desc,optional"` //描述 Required int64 `json:"required,optional"` //是否必须 1:是 2:否 Affordance *string `json:"affordance,optional"` //各功能类型的详细参数定义 IsCanSceneLinkage int64 `json:"isCanSceneLinkage,optional"` //是否可以场景联动 FuncGroup int64 `json:"funcGroup,optional"` // 功能分类: 1:普通功能 2:系统功能 UserPerm int64 `json:"userPerm,optional"` //用户权限操作: 1:r(只读) 3:rw(可读可写) IsHistory int64 `json:"isHistory,optional"` // 是否存储历史记录 Order int64 `json:"order,optional"` // 排序 ControlMode int64 `json:"controlMode,optional"` //控制模式: 1: 可以群控,可以单控 2:只能单控 }
type CommonSchemaUpdateReq ¶
type CommonSchemaUpdateReq struct {
*CommonSchemaInfo
}
type CompareInt64 ¶
type DeviceAuth5AccessReq ¶
type DeviceAuth5AccessResp ¶
type DeviceAuth5AccessResp struct {
Result string `json:"result"` //验证结果 "allow" | "deny" | "ignore"
}
type DeviceAuth5LoginReq ¶
type DeviceAuth5LoginResp ¶
type DeviceAuthAccessReq ¶
type DeviceAuthLoginReq ¶
type DeviceAuthRootCheckReq ¶
type DeviceAuthRootCheckReq struct { Username string `json:"username,omitempty"` //用户名 Password string `json:"password,optional,omitempty"` //密码 ClientID string `json:"clientID,omitempty"` //clientID Ip string `json:"ip,omitempty"` //访问的ip地址 Certificate []byte `json:"certificate,optional,omitempty"` //客户端证书 }
type DeviceCore ¶
type DeviceCountInfo ¶
type DeviceCountReq ¶
type DeviceCountResp ¶
type DeviceCountResp struct {
List []*DeviceCountInfo `json:"list"`
}
type DeviceError ¶
type DeviceGateWayIndexReq ¶
type DeviceGateWayIndexResp ¶
type DeviceGateWayIndexResp struct { List []*DeviceInfo `json:"list"` //分组信息 Total int64 `json:"total"` //总数(只有分页的时候会返回) }
type DeviceGateWayMultiCreateReq ¶
type DeviceGateWayMultiCreateReq struct { GateWayProductID string `json:"gateWayProductID"` //产品ID GateWayDeviceName string `json:"gateWaydeviceName"` //设备名称 List []*DeviceCore `json:"list,optional"` //分组tag }
type DeviceGateWayMultiDeleteReq ¶
type DeviceGateWayMultiDeleteReq struct { GateWayProductID string `json:"gateWayProductID"` //产品ID GateWayDeviceName string `json:"gateWaydeviceName"` //设备名称 List []*DeviceCore `json:"list,optional"` //分组tag }
type DeviceInfo ¶
type DeviceInfo struct { ID int64 `json:"id,optional,omitempty"` TenantCode string `json:"tenantCode,optional,omitempty"` ProductID string `json:"productID"` //产品id 只读 ProjectID int64 `json:"projectID,string,optional"` //项目id 只读 ProductName string `json:"productName,optional,omitempty"` DeviceType int64 `json:"deviceType,optional,omitempty"` //设备类型:1:设备,2:网关,3:子设备 ProductImg string `json:"productImg,optional,omitempty"` //产品图片 AreaID int64 `json:"areaID,string,optional,omitempty"` //项目区域id 只读 DeviceName string `json:"deviceName"` //设备名称 读写 DeviceAlias *string `json:"deviceAlias,optional"` //设备别名 读写 Secret string `json:"secret,optional,omitempty"` //设备秘钥 只读 Cert string `json:"cert,optional,omitempty"` // 设备证书 只读 Imei string `json:"imei,optional,omitempty"` // IMEI号信息 只读 Mac string `json:"mac,optional,omitempty"` // MAC号信息 只读 CategoryID int64 `json:"categoryID,optional,omitempty"` //产品品类 Version *string `json:"version,optional,omitempty"` // 固件版本 读写 HardInfo string `json:"hardInfo,optional,omitempty"` // 模组硬件型号 只读 SoftInfo string `json:"softInfo,optional,omitempty"` // 模组软件版本 只读 MobileOperator int64 `json:"mobileOperator,optional,range=[0:4],omitempty"` //移动运营商:1)移动 2)联通 3)电信 4)广电 Phone *string `json:"phone,optional,omitempty"` //手机号 Iccid *string `json:"iccid,optional,omitempty"` //SIM卡卡号 Position *Point `json:"position,optional,omitempty"` //设备定位,默认百度坐标系 Address *string `json:"address,optional,omitempty"` //所在地址 Adcode *string `json:"adcode,optional,omitempty"` //地区编码 Tags []*Tag `json:"tags,optional,omitempty"` // 设备tag SchemaAlias map[string]string `json:"schemaAlias,optional,omitempty"` //设备物模型别名,如果是结构体类型则key为xxx.xxx IsOnline int64 `json:"isOnline,optional,range=[0:2],omitempty"` // 在线状态 1离线 2在线 只读 FirstLogin int64 `json:"firstLogin,optional,string,omitempty"` //激活时间 只读 FirstBind int64 `json:"firstBind,optional,string,omitempty"` LastLogin int64 `json:"lastLogin,optional,string,omitempty"` //最后上线时间 只读 ExpTime *int64 `json:"expTime,optional,string,omitempty"` //到期时间 LogLevel int64 `json:"logLevel,optional,range=[0:5],omitempty"` // 日志级别:1)关闭 2)错误 3)告警 4)信息 5)调试 读写 Rssi int64 `json:"rssi,optional,omitempty"` //信号强度 CreatedTime int64 `json:"createdTime,optional,string,omitempty"` //创建时间 只读 Status int64 `json:"status,optional,omitempty"` //设备状态 1-未激活,2-在线,3-离线 4-异常(频繁上下线,告警中) IsEnable int64 `json:"isEnable,optional,omitempty"` //是否启用 WithProperties map[string]*DeviceInfoWithProperty `json:"withProperties,optional,omitempty"` //获取的属性列表,如果不传withProperty,则不会返回 ProtocolConf []*Tag `json:"protocolConf,optional,omitempty"` //协议配置 Profiles map[string]string `json:"profiles,optional,omitempty"` Owner *UserCore `json:"owner,optional,omitempty"` RatedPower int64 `json:"ratedPower,optional,omitempty"` NetType int64 `json:"netType,optional,range=[0:8],omitempty"` //通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网 NeedConfirmVersion string `json:"needConfirmVersion,optional,omitempty"` //待确认升级的版本 UserID int64 `json:"userID,string,optional,omitempty"` Distributor *IDPath `json:"distributor,optional,omitempty"` Gateway *DeviceInfo `json:"gateway,optional,omitempty"` //子设备绑定的网关信息,只读 Area *AreaInfo `json:"area,optional,omitempty"` //区域信息 }
type DeviceInfoBindReq ¶
type DeviceInfoBindReq struct { Device DeviceCore `json:"device"` AreaID int64 `json:"areaID,optional,string"` ProtocolCode string `json:"protocolCode,optional"` }
type DeviceInfoCanBindReq ¶
type DeviceInfoCanBindReq struct {
Device DeviceCore `json:"device"`
}
type DeviceInfoDeleteReq ¶
type DeviceInfoIndexReq ¶
type DeviceInfoIndexReq struct { Page *PageInfo `json:"page,optional"` //分页信息 只获取一个则不填 TenantCode string `json:"tenantCode,optional"` ProductID string `json:"productID,optional"` //产品id 为空时获取所有产品 ProductIDs []string `json:"productIDs,optional"` //产品id 为空时获取所有产品 DeviceName string `json:"deviceName,optional"` //过滤条件:模糊查询 设备名 DeviceNames []string `json:"deviceNames,optional"` //过滤条件:精准查询 设备名 ExpTime *CompareInt64 `json:"expTime,optional"` //到期时间 RatedPower *CompareInt64 `json:"ratedPower,optional"` //额定功率:单位w/h DeviceAlias string `json:"deviceAlias,optional"` //过滤条件:模糊查询 设备别名 DeviceTypes []int64 `json:"deviceTypes,optional"` //设备类型:1:设备,2:网关,3:子设备//设备类型:1:设备,2:网关,3:子设备 Position *Point `json:"position,optional"` //设备定位,默认百度坐标系,用于获取以该点为中心,Range范围内的设备列表,与Range连用 Range int64 `json:"range,optional"` //过滤条件:距离坐标点固定范围内的设备 单位:米 Tags []*Tag `json:"tags,optional"` // key tag过滤查询,非模糊查询 为tag的名,value为tag对应的值 WithProperties []string `json:"withProperties,optional"` //如果不为nil,如果为空,获取设备所有最新属性 如果传了属性列表,则会返回属性列表,如果没有匹配的则不会返回 WithProfiles []string `json:"withProfiles,optional"` // AreaIDs []int64 `json:"areaIDs,optional"` //项目区域ids IsOnline int64 `json:"isOnline,optional,range=[0:2]"` // 在线状态过滤 1离线 2在线 ProductCategoryID int64 `json:"productCategoryID,optional"` WithCollect int64 `json:"withCollect,optional,range=[0:2]"` // 过滤收藏的设备(这里只获取收藏的设备) 1: 同时获取收藏的设备 2:只获取收藏的设备 Versions []string `json:"versions,optional"` NotVersion string `json:"notVersion,optional"` Gateway *DeviceCore `json:"gateway,optional"` //过滤网关 GroupID int64 `json:"groupID,optional,string"` NotGroupID int64 `json:"notGroupID,optional,string"` NotAreaID int64 `json:"notAreaID,optional,string"` Devices []*DeviceCore `json:"devices,optional"` Status int64 `json:"status,optional"` //设备状态 1-未激活,2-在线,3-离线 4-异常(频繁上下线,告警中) WithOwner bool `json:"withOwner,optional"` //同时获取拥有人的信息 HasOwner int64 `json:"hasOwner,optional"` //是否被人拥有,1为是 2为否 UserID int64 `json:"userID,string,optional"` NetType int64 `json:"netType,optional,range=[0:8]"` //通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网 WithArea bool `json:"withArea,optional"` //同时返回区域信息 IsOnlyCore bool `json:"isOnlyCore,optional"` //只返回核心信息 Iccid string `json:"iccid,optional,omitempty"` //SIM卡卡号 }
type DeviceInfoIndexResp ¶
type DeviceInfoIndexResp struct { List []*DeviceInfo `json:"list"` //设备信息 Total int64 `json:"total"` //总数(只有分页的时候会返回) }
type DeviceInfoMultiBindReq ¶
type DeviceInfoMultiBindReq struct { Devices []*DeviceCore `json:"devices"` AreaID int64 `json:"areaID,optional,string"` }
type DeviceInfoMultiBindResp ¶
type DeviceInfoMultiBindResp struct {
Errs []*DeviceError `json:"errs"`
}
type DeviceInfoMultiUpdateReq ¶
type DeviceInfoMultiUpdateReq struct { Devices []*DeviceCore `json:"devices"` AreaID int64 `json:"areaID,string,optional"` RatedPower int64 `json:"ratedPower,optional,omitempty"` }
type DeviceInfoReadReq ¶
type DeviceInfoReadReq struct { ProductID string `json:"productID,optional"` //产品id 为空时获取所有产品 DeviceName string `json:"deviceName"` //设备名称 读写 WithProperties []string `json:"withProperties,optional"` //如果不为nil,如果为空,获取设备所有最新属性 如果传了属性列表,则会返回属性列表 WithProfiles []string `json:"withProfiles,optional"` // WithOwner bool `json:"withOwner,optional"` //同时获取拥有人的信息 WithGateway bool `json:"withGateway,optional"` //同时返回子设备绑定的网关信息 }
type DeviceInfoSaveReq ¶
type DeviceInfoSaveReq struct { ProductID string `json:"productID"` //产品id 只读 DeviceName string `json:"deviceName"` //设备名称 读写 DeviceAlias *string `json:"deviceAlias,optional"` //设备别名 读写 LogLevel int64 `json:"logLevel,optional,range=[0:5]"` // 日志级别:1)关闭 2)错误 3)告警 4)信息 5)调试 读写 Address *string `json:"address,optional"` //所在地址 Position *Point `json:"position,optional"` //设备定位,默认百度坐标系 Tags []*Tag `json:"tags,optional"` // 设备tag Phone *string `json:"phone,optional"` //手机号 Iccid *string `json:"iccid,optional"` //SIM卡卡号 UserID int64 `json:"userID,string,optional"` // 用户id MobileOperator int64 `json:"mobileOperator,optional,range=[0:4]"` //移动运营商:1)移动 2)联通 3)电信 4)广电 AreaID int64 `json:"areaID,string,optional"` //项目区域id 只读(1: root节点 2: 未分类节点 其他:子节点) SchemaAlias map[string]string `json:"schemaAlias,optional"` //设备物模型别名,如果是结构体类型则key为xxx.xxx }
type DeviceInfoTransferReq ¶
type DeviceInfoTransferReq struct { Device *DeviceCore `json:"device,optional"` Devices []*DeviceCore `json:"devices,optional"` SrcProjectID int64 `json:"srcProjectID,string,optional"` //指定原来的项目ID,不写使用头 TransferTo int64 `json:"transferTo"` //转让给: 1: 某个人 2: 自己的某个项目 UserID int64 `json:"userID,string,optional"` ProjectID int64 `json:"projectID,string,optional"` AreaID int64 `json:"areaID,string,optional"` //转移到项目时指定区域ID IsCleanData int64 `json:"isCleanData"` //是否清除数据:1是 2否 }
type DeviceInfoWithProperty ¶
type DeviceInteractMultiSendPropertyMsg ¶
type DeviceInteractMultiSendPropertyMsg struct { ProductID string `json:"productID"` //产品id DeviceName string `json:"deviceName"` //设备名 Code int64 `json:"code"` //设备返回状态码 Msg string `json:"msg"` //返回状态 MsgToken string `json:"msgToken"` //调用id SysCode int64 `json:"sysCode"` //系统错误码 SysMsg string `json:"sysMsg"` //系统错误信息 }
type DeviceInteractMultiSendPropertyReq ¶
type DeviceInteractMultiSendPropertyReq struct { AreaID int64 `json:"areaID,string,optional"` //项目区域id,传了优先从项目区域中获取设备列表 GroupID int64 `json:"groupID,string,optional"` //分组ID,传了会从分组下获取设备 ProductID string `json:"productID,optional"` //产品id DeviceNames []string `json:"deviceNames,optional"` //设备名列表 Devices []*DeviceCore `json:"devices,optional"` //如果是不同的产品,则传这个字段,上面两个参数填了优先使用 IsAsync bool `json:"isAsync,optional"` //是否异步操作 异步情况通过获取接口来获取 SyncTimeout int64 `json:"syncTimeout,optional"` //同步超时时间(单位:秒,不填默认3秒) ShadowControl int64 `json:"shadowControl,optional"` //设备影子控制 0:自动,当设备不在线的时候设置设备影子,设备在线时直接下发给设备 1:只实时下发,不在线报错 2:如果有设备影子只修改影子,没有的也不下发 Data string `json:"data"` //属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义 }
type DeviceInteractMultiSendPropertyResp ¶
type DeviceInteractMultiSendPropertyResp struct {
List []*DeviceInteractMultiSendPropertyMsg `json:"list"` //批量设备返回结果列表
}
type DeviceInteractSendActionReq ¶
type DeviceInteractSendActionReq struct { ProductID string `json:"productID"` //产品id DeviceName string `json:"deviceName"` //设备名 ActionID string `json:"actionID"` //产品数据模板中行为功能的标识符,由开发者自行根据设备的应用场景定义 InputParams string `json:"inputParams,optional"` //输入参数 IsAsync bool `json:"isAsync,optional"` //是否异步操作 异步情况通过获取接口来获取 Option *SendOption `json:"option,optional"` //异步重试选项 }
type DeviceInteractSendPropertyReq ¶
type DeviceInteractSendPropertyReq struct { ProductID string `json:"productID"` //产品id DeviceName string `json:"deviceName"` //设备名 Data string `json:"data"` //属性数据, JSON格式字符串, 注意字段需要在物模型属性里定义 IsAsync bool `json:"isAsync,optional"` //是否异步操作 异步情况通过获取接口来获取 SyncTimeout int64 `json:"syncTimeout,optional"` //同步超时时间(单位:秒,不填默认3秒) ShadowControl int64 `json:"shadowControl,optional"` //设备影子控制 0:自动,当设备不在线的时候设置设备影子,设备在线时直接下发给设备 1:只实时下发,不在线报错 2:如果有设备影子只修改影子,没有的也不下发 3:只修改云端的值 4:只修改云端的值并记录操作日志 WithProfile *WithProfile `json:"withProfile,optional"` //同时修改该设备的配置信息 }
type DeviceModuleVersion ¶
type DeviceModuleVersionIndexResp ¶
type DeviceModuleVersionIndexResp struct { List []*DeviceModuleVersion `json:"list"` //设备信息 Total int64 `json:"total"` //总数(只有分页的时候会返回) }
type DeviceMsgEventLogIndexReq ¶
type DeviceMsgEventLogIndexReq struct { DeviceNames []string `json:"deviceNames,optional"` //设备名(不填获取产品下所有设备) ProductID string `json:"productID,optional"` //产品id 获取产品id下的所有设备信息 DataID string `json:"dataID,optional,omitempty"` //获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条,如果没有获取到的不会返回值 TimeStart int64 `json:"timeStart,string,optional,omitempty"` //获取时间的开始 TimeEnd int64 `json:"timeEnd,string,optional,omitempty"` //时间的结束 Page *PageInfo `json:"page,optional"` //分页信息 Types []string `json:"types,optional"` //类型 事件类型: 信息:info 告警alert 故障:fault }
type DeviceMsgEventLogIndexResp ¶
type DeviceMsgEventLogIndexResp struct { List []*DeviceMsgEventLogInfo `json:"list"` //数据 Total int64 `json:"total"` //总数 }
type DeviceMsgEventLogInfo ¶
type DeviceMsgHubLogIndexReq ¶
type DeviceMsgHubLogIndexReq struct { DeviceName string `json:"deviceName,omitempty"` //设备名 ProductID string `json:"productID,omitempty"` //产品id 获取产品id下的所有设备信息 TimeStart int64 `json:"timeStart,string,optional,omitempty"` //获取时间的开始 TimeEnd int64 `json:"timeEnd,string,optional,omitempty"` //时间的结束 Page *PageInfo `json:"page,optional"` //分页信息 Actions []string `json:"actions,optional"` //过滤操作类型 connected:上线 disconnected:下线 property:属性 event:事件 action:操作 thing:物模型提交的操作为匹配的日志 Topics []string `json:"topics,optional"` //过滤主题 Content string `json:"content,optional"` //过滤内容 RequestID string `json:"requestID,optional"` //过滤请求ID }
type DeviceMsgHubLogIndexResp ¶
type DeviceMsgHubLogIndexResp struct { List []*DeviceMsgHubLogInfo `json:"list"` //数据 Total int64 `json:"total"` //总数 }
type DeviceMsgHubLogInfo ¶
type DeviceMsgHubLogInfo struct { Timestamp int64 `json:"timestamp,string"` Action string `json:"action"` //connected:上线 disconnected:下线 property:属性 event:事件 action:操作 thing:物模型提交的操作为匹配的日志 RequestID string `json:"requestID"` TraceID string `json:"traceID"` Topic string `json:"topic"` Content string `json:"content"` ResultCode int64 `json:"resultCode,string"` RespPayload string `json:"respPayload"` }
type DeviceMsgPropertyIndexResp ¶
type DeviceMsgPropertyIndexResp struct { List []*DeviceMsgPropertyLogInfo `json:"list"` //数据 Total int64 `json:"total"` //总数 }
type DeviceMsgPropertyLogIndexReq ¶
type DeviceMsgPropertyLogIndexReq struct { DeviceNames []string `json:"deviceNames,omitempty"` //设备名(不填获取产品下所有设备) ProductID string `json:"productID,omitempty"` //产品id 获取产品id下的所有设备信息 DataID string `json:"dataID,optional,omitempty"` //获取的具体标识符的数据 如果不指定则获取所有属性数据,一个属性一条,如果没有获取到的不会返回值 TimeStart int64 `json:"timeStart,string,optional,omitempty"` //获取时间的开始 TimeEnd int64 `json:"timeEnd,string,optional,omitempty"` //时间的结束 Page *PageInfo `json:"page,optional"` //分页信息 Interval int64 `json:"interval,optional"` //分页信息 ArgFunc string `json:"argFunc,optional"` //分页信息 Fill string `json:"fill,optional"` //填充模式 参考:https://docs.taosdata.com/taos-sql/distinguished/ Order int64 `json:"order,optional"` //时间排序 0:aes(默认,从久到近排序) 1:desc(时间从近到久排序) }
type DeviceMsgSdkIndexResp ¶
type DeviceMsgSdkIndexResp struct { List []*DeviceMsgSdkInfo `json:"list"` //数据 Total int64 `json:"total"` //总数 }
type DeviceMsgSdkInfo ¶
type DeviceMsgSdkLogIndexReq ¶
type DeviceMsgSdkLogIndexReq struct { DeviceName string `json:"deviceName,omitempty"` //设备名 ProductID string `json:"productID,omitempty"` //产品id 获取产品id下的所有设备信息 TimeStart int64 `json:"timeStart,string,optional,omitempty"` //获取时间的开始 TimeEnd int64 `json:"timeEnd,string,optional,omitempty"` //时间的结束 LogLevel int `json:"logLevel,optional"` //等级 Page *PageInfo `json:"page,optional"` //分页信息 }
type DeviceMsgSendLogIndexReq ¶
type DeviceMsgSendLogIndexReq struct { ProductID string `json:"productID,optional"` //产品id DeviceName string `json:"deviceName,optional"` //设备名 TimeStart int64 `json:"timeStart,string,optional"` //获取时间的开始(毫秒时间戳) TimeEnd int64 `json:"timeEnd,string,optional"` //时间的结束(毫秒时间戳) Page *PageInfo `json:"page,optional"` //分页信息 UserID int64 `json:"userID,string,optional"` Actions []string `json:"actions,optional"` ResultCode int64 `json:"resultCode,optional"` //请求结果状态,200为成功 }
type DeviceMsgSendLogIndexResp ¶
type DeviceMsgSendLogIndexResp struct { List []*DeviceMsgSendLogInfo `json:"list"` //数据 Total int64 `json:"total"` //总数 }
type DeviceMsgSendLogInfo ¶
type DeviceMsgSendLogInfo struct { Timestamp int64 `json:"timestamp,string,optional"` //发生时间戳(毫秒时间戳) Account string `json:"account,optional"` UserID int64 `json:"userID,string,optional"` // ProductID string `json:"productID,optional"` // DeviceName string `json:"deviceName,optional"` // Action string `json:"action,optional"` //操作类型 propertySend:属性控制 actionSend:操作控制 propertyGetReportSend:获取最新属性请求 DataID string `json:"dataID,optional"` //identify TraceID string `json:"traceID,optional"` //服务器端事务id Content string `json:"content,optional"` //操作的内容 ResultCode int64 `json:"resultCode,optional"` //请求结果状态,200为成功 }
type DeviceMsgShadowIndex ¶
type DeviceMsgShadowIndexResp ¶
type DeviceMsgShadowIndexResp struct {
List []*DeviceMsgShadowIndex `json:"list"`
}
type DeviceMsgStatusLogIndexReq ¶
type DeviceMsgStatusLogIndexReq struct { ProductID string `json:"productID,optional"` //产品id DeviceName string `json:"deviceName,optional"` //设备名 TimeStart int64 `json:"timeStart,string,optional"` //获取时间的开始(毫秒时间戳) TimeEnd int64 `json:"timeEnd,string,optional"` //时间的结束(毫秒时间戳) Page *PageInfo `json:"page,optional"` //分页信息 Status int64 `json:"status,optional"` //在线状态 }
type DeviceMsgStatusLogIndexResp ¶
type DeviceMsgStatusLogIndexResp struct { List []*DeviceMsgStatusLogInfo `json:"list"` //数据 Total int64 `json:"total"` //总数 }
type DeviceMsgStatusLogInfo ¶
type DeviceMultiImportReq ¶
type DeviceMultiImportReq struct { }
type DeviceMultiImportResp ¶
type DeviceMultiImportResp struct { Total int64 `json:"total"` //当前表格数据量 Headers *DeviceMultiImportRow `json:"headers"` //表格表头信息 Errdata []*DeviceMultiImportRow `json:"errdata"` //批量导入错误清单 }
type DeviceMultiImportRow ¶
type DeviceMultiImportRow struct { Row int64 `json:"row"` //【提示】数据所在表格行 ProductID string `json:"productID"` //【必填】产品ID DeviceName string `json:"deviceName"` //【必填】设备名称 DeviceAlias string `json:"deviceAlias"` //【选填】设备别名 Secret string `json:"secret"` //【选填】设备秘钥 LogLevel string `json:"logLevel"` //【选填】日志级别(关闭/错误/告警/信息/调试) Tags string `json:"tags"` //【选填】设备标签(格式k1:v1;k2:v2;...) Position string `json:"position"` //【选填】设备位置百度坐标(格式:经,纬) Address string `json:"address"` //【选填】设备所在详细地址 Tips string `json:"tips"` //【提示】模板使用提示 }
type DeviceProfile ¶
type DeviceProfile struct { Device DeviceCore `json:"device"` Code string `json:"code"` Params string `json:"params"` }
type DeviceProfileIndexReq ¶
type DeviceProfileIndexReq struct { Device *DeviceCore `json:"device"` Codes []string `json:"codes,optional"` }
type DeviceProfileIndexResp ¶
type DeviceProfileIndexResp struct {
Profiles []*DeviceProfile `json:"profiles,omitempty"`
}
type DeviceProfileReadReq ¶
type DeviceProfileReadReq struct { Device DeviceCore `json:"device"` Code string `json:"code"` }
type DeviceRegisterReq ¶
type DeviceRegisterResp ¶
type FirmwareCreateReq ¶
type FirmwareCreateReq struct { ProductID string `json:"productID"` Name string `json:"name"` Version string `json:"version"` SignMethod string `json:"signMethod"` Desc string `json:"desc,optional"` IsDiff int64 `json:"isDiff"` SrcVersion string `json:"srcVersion"` IsNeedToVerify int64 `json:"isNeedToVerify"` Extra string `json:"extra,optional"` ModuleCode string `json:"moduleCode,optional"` FilePaths []string `json:"filePaths"` }
type FirmwareFile ¶
type FirmwareIndexReq ¶
type FirmwareIndexResp ¶
type FirmwareIndexResp struct { List []FirmwareInfo `json:"list"` Total int64 `json:"total"` }
type FirmwareInfo ¶
type FirmwareInfo struct { ID int64 `json:"id"` //固件id Name string `json:"name"` //固件升级包名称 Version string `json:"version"` //版本号 ProductID string `json:"productID"` //产品id ProductName string `json:"productName"` //产品名称 Status int64 `json:"status"` //状态 CreatedTime int64 `json:"createdTime"` //添加时间 SignMethod string `json:"signMethod"` //签名方式:MD5/SHA256 Desc string `json:"desc"` //文件描述 Extra string `json:"extra"` //推给设备端端消息 IsDiff int64 `json:"isDiff"` //整包or差包 IsNeedToVerify int64 `json:"isNeedToVerify"` //是否需要验证 ModuleCode string `json:"moduleCode"` //模块编码 FileList []*FirmwareFile `json:"fileList"` //文件列表 }
type FirmwareUpdateReq ¶
type GatewayCanBindIndexReq ¶
type GatewayCanBindIndexReq struct {
Gateway *DeviceCore `json:"gateway"` //如果是不同的产品,则传这个字段,上面两个参数填了优先使用
}
type GatewayCanBindIndexResp ¶
type GatewayCanBindIndexResp struct { SubDevices []*DeviceCore `json:"subDevices"` //如果是不同的产品,则传这个字段,上面两个参数填了优先使用 UpdatedTime int64 `json:"updatedTime"` // }
type GatewayGetFoundReq ¶
type GatewayNotifyBindSendReq ¶
type GatewayNotifyBindSendReq struct { Gateway *DeviceCore `json:"gateway"` //如果是不同的产品,则传这个字段,上面两个参数填了优先使用 SubDevices []*DeviceCore `json:"subDevices"` //如果是不同的产品,则传这个字段,上面两个参数填了优先使用 }
type GroupDeviceIndexReq ¶
type GroupDeviceIndexReq struct { Page *PageInfo `json:"page,optional"` //分页信息 只获取一个则不填 GroupID int64 `json:"groupID"` //分组ID ProductID string `json:"productID,optional"` //产品ID DeviceName string `json:"deviceName,optional"` //设备名称 WithProperties []string `json:"withProperties,optional"` //如果不为nil,如果为空,获取设备所有最新属性 如果传了属性列表,则会返回属性列表 WithProfiles []string `json:"withProfiles,optional"` // }
type GroupDeviceIndexResp ¶
type GroupDeviceIndexResp struct { List []*DeviceInfo `json:"list"` //分组信息 Total int64 `json:"total"` //总数(只有分页的时候会返回) }
type GroupDeviceMultiDeleteReq ¶
type GroupDeviceMultiDeleteReq struct { GroupID int64 `json:"groupID"` //分组ID List []*DeviceCore `json:"list,optional"` //分组tag }
type GroupDeviceMultiSaveReq ¶
type GroupDeviceMultiSaveReq struct { GroupID int64 `json:"groupID"` //分组ID List []*DeviceCore `json:"list,optional"` //分组tag }
type GroupInfo ¶
type GroupInfo struct { ID int64 `json:"id,optional"` //分组ID ParentID int64 `json:"parentID,optional"` //父组ID ProjectID int64 `json:"projectID,string,optional,omitempty"` //项目ID AreaID int64 `json:"areaID,string,optional,omitempty"` //区域ID Name string `json:"name,optional"` //分组名称 ProductID string `json:"productID,optional"` //产品ID ProductName string `json:"productName,optional,omitempty"` //产品ID CreatedTime int64 `json:"createdTime,string,optional"` //创建时间 Desc string `json:"desc,optional,omitempty"` //分组描述 DeviceCount int64 `json:"deviceCount,optional,omitempty"` //设备数量统计 IsLeaf int64 `json:"isLeaf,optional"` Tags []*Tag `json:"tags,optional,omitempty"` //分组tag Devices []*DeviceCore `json:"devices,optional,omitempty"` Children []*GroupInfo `json:"children,optional,omitempty"` }
type GroupInfoIndexReq ¶
type GroupInfoIndexReq struct { Page *PageInfo `json:"page,optional"` //分页信息 只获取一个则不填 AreaID int64 `json:"areaID,string,optional"` //区域ID ParentID int64 `json:"parentID,optional"` //父组ID ProductID string `json:"productID,optional"` //产品ID Name string `json:"name,optional"` //分组名称 Tags []*Tag `json:"tags,optional"` //分组tag }
type GroupInfoIndexResp ¶
type LogActionScene ¶
type OtaFirmwareCreateReq ¶
type OtaFirmwareCreateReq struct { Name string `json:"name"` //升级包名称 ProductID string `json:"productID"` //产品id Version string `json:"version"` //升级包版本 IsDiff int32 `json:"isDiff" enums:"1,2"` //是否差分包,1:整包,2:差分 SignMethod string `json:"signMethod"` //签名方法 MD5/SHA@256 Desc *string `json:"desc"` //描述 ExtData *string `json:"extData"` //自定义数据 Files []*OtaFirmwareFile `json:"files"` //升级包附件列表,最多支持上传20个文件,总文件大小不能超过1,000 MB。 }
type OtaFirmwareDeviceIndexResp ¶
type OtaFirmwareDeviceIndexResp struct { List []*OtaFirmwareDeviceInfo `json:"list"` // OTA任务信息列表 Total int64 `json:"total"` // 总数 }
type OtaFirmwareDeviceInfo ¶
type OtaFirmwareDeviceInfo struct { ID int64 `json:"id"` FirmwareID int64 `json:"firmwareID"` JobID int64 `json:"jobID"` ProductID string `json:"productID"` ProductName string `json:"productName"` DeviceName string `json:"deviceName"` SrcVersion string `json:"srcVersion"` DestVersion string `json:"destVersion"` Step int64 `json:"step"` Detail string `json:"detail"` Status int64 `json:"status"` CreatedTime int64 `json:"createdTime"` UpdatedTime int64 `json:"updatedTime"` }
type OtaFirmwareDeviceInfoResp ¶
type OtaFirmwareDeviceInfoResp struct {
Versions string `json:"versions"`
}
type OtaFirmwareFile ¶
type OtaFirmwareFileInfo ¶
type OtaFirmwareIndex ¶
type OtaFirmwareIndex struct { ID int64 `json:"id"` //固件升级包编号 Name string `json:"name"` //升级包名称 Version string `json:"version"` //升级包版本 ProductID string `json:"productID"` //产品id ProductName string `json:"productName"` //产品名称 IsDiff int32 `json:"isDiff" enums:"1,2"` //是否差分包,1:整包,2:差分 CreatedTime int64 `json:"createdTime"` //创建时间 只读 SignMethod string `json:"signMethod"` //签名方法 }
type OtaFirmwareIndexReq ¶
type OtaFirmwareIndexResp ¶
type OtaFirmwareIndexResp struct { List []*OtaFirmwareIndex `json:"list"` //数据 Total int64 `json:"total"` //总数 }
type OtaFirmwareInfo ¶
type OtaFirmwareInfo struct { FirmwareID int64 `json:"firmwareID"` //固件升级包编号 Name string `json:"name"` //升级包名称 Version string `json:"version"` //升级包版本 ProductID string `json:"productID"` //产品id ProductName string `json:"productName"` //产品名称 IsDiff int32 `json:"isDiff" enums:"1,2"` //是否差分包,1:整包,2:差分 CreatedTime int64 `json:"createdTime"` //创建时间 只读 SignMethod string `json:"signMethod"` //签名方法 Desc *string `json:"desc"` //描述 ExtData *string `json:"extData"` //自定义数据 }
type OtaFirmwareJobDynamic ¶
type OtaFirmwareJobDynamic struct {
DynamicMode int64 `json:"dynamicMode,optional,range=[0:2]"` //
}
type OtaFirmwareJobIndexReq ¶
type OtaFirmwareJobInfo ¶
type OtaFirmwareJobInfo struct { ID int64 `json:"id,optional"` FirmwareID int64 `json:"firmwareID,optional"` // 升级包ID,升级包的唯一标识符。 Type int64 `json:"type,optional,range=[0:2]"` // 升级包所属产品的JobType。 验证升级包:1 批量升级:2 Status int64 `json:"status,optional,range=[0:4]"` // 批次状态,计划中:1 执行中:2 已完成:3 已取消:4 UpgradeType int64 `json:"upgradeType,optional,range=[0:2]"` // 升级策略,1-静态,2-动态 SrcVersions []string `json:"srcVersions,optional"` // 待升级版本号列表。最多可传入10个版本号。用逗号分隔多个版本号 RetryInterval int64 `json:"retryInterval,optional"` // 设备升级失败后,自动重试的时间间隔,单位为分钟。 动态升级 静态升级 RetryCount int64 `json:"retryCount,optional"` // 自动重试次数。1/2/5次 动态升级 静态升级 TimeoutInMinutes int64 `json:"timeoutInMinutes,optional"` // 设备升级超时时间,单位为分钟。 动态升级 静态升级 MaximumPerMinute int64 `json:"maximumPerMinute,optional"` // 每分钟最多向多少个设备推送升级包下载URL。 动态升级 静态升级 IsOverwriteMode int64 `json:"isOverwriteMode,optional,range=[0:2]"` // 是否覆盖之前的升级任务。取值:2(不覆盖)、1(覆盖)。 IsNeedPush int64 `json:"isNeedPush,optional,range=[0:2]"` // 物联网平台是否主动向设备推送升级任务。 IsNeedConfirm int64 `json:"isNeedConfirm,optional,range=[0:2]"` Target string `json:"target,optional"` // 分组升级和区域升级填写对应的id TargetSelection int64 `json:"targetSelection,optional,range=[0:4]"` //升级范围。 1:全量升级。 2:定向升级。 3:灰度升级。 4:分组升级(不做) 5: 区域升级(不做) TenantCodes []string `json:"tenantCodes,optional"` //指定租户 CreatedTime int64 `json:"createdTime,optional"` OtaFirmwareJobDynamic OtaFirmwareJobStatic }
type OtaFirmwareJobInfoIndexResp ¶
type OtaFirmwareJobInfoIndexResp struct { List []*OtaFirmwareJobInfo `json:"list"` // OTA作业信息列表 Total int64 `json:"total"` // 总数 }
type OtaFirmwareJobStatic ¶
type OtaFirmwareJobStatic struct { TargetDeviceNames []string `json:"targetDeviceNames,optional"` // 定向升级的设备名称列表。最多可传入200个设备名称。以逗号分隔 ScheduleFinishTime int64 `json:"scheduleFinishTime,optional"` // 指定结束升级的时间,单位为毫秒。 ScheduleTime int64 `json:"scheduleTime,optional"` GrayPercent int64 `json:"grayPercent,optional"` //灰度的范围,小数点后两位, 1.23%为 123 }
type OtaFirmwareReadResp ¶
type OtaFirmwareReadResp struct { ID int64 `json:"id"` //固件升级包编号 Name string `json:"name"` //升级包名称 Version string `json:"version"` //升级包版本 ProductID string `json:"productID"` //产品id ProductName string `json:"productName"` //产品名称 IsDiff int32 `json:"isDiff" enums:"1,2"` //是否差分包,1:整包,2:差分 IsNeedToVerify int64 `json:"isNeedToVerify"` CreatedTime int64 `json:"createdTime"` //创建时间 只读 SignMethod string `json:"signMethod"` //签名方法 Desc *string `json:"desc"` //描述 ExtData *string `json:"extData"` //自定义数据 Files []*OtaFirmwareFileInfo `json:"files"` }
type OtaModuleInfo ¶
type OtaModuleInfoIndexReq ¶
type OtaModuleInfoIndexResp ¶
type OtaModuleInfoIndexResp struct { List []*OtaModuleInfo `json:"list"` // OTA作业信息列表 Total int64 `json:"total"` // 总数 }
type ProductCategory ¶
type ProductCategory struct { ID int64 `json:"id,optional"` ParentID int64 `json:"parentID,optional"` IDPath []int64 `json:"idPath,optional"` //只读 Name string `json:"name,optional"` Desc *string `json:"desc,optional"` //描述 HeadImg string `json:"headImg,optional"` // 用户头像 IsUpdateHeadImg bool `json:"isUpdateHeadImg,omitempty,optional"` // 用户头像 IsLeaf int64 `json:"isLeaf,optional"` DeviceCount int64 `json:"deviceCount,optional"` //设备数量 Children []*ProductCategory `json:"children,optional"` }
type ProductCategoryIndexReq ¶
type ProductCategoryIndexResp ¶
type ProductCategoryIndexResp struct { List []*ProductCategory `json:"list"` //产品信息 Total int64 `json:"total,optional"` //拥有的总数 Num int64 `json:"num,optional"` //返回的数量 }
type ProductCategorySchemaIndexResp ¶
type ProductCategorySchemaIndexResp struct {
Identifiers []string `json:"identifiers"`
}
type ProductCustom ¶
type ProductCustom struct { ProductID string `json:"productID"` TransformScript *string `json:"transformScript,optional"` //协议转换脚本 LoginAuthScript *string `json:"loginAuthScript,optional"` //登录认证脚本 ScriptLang int64 `json:"scriptLang,optional"` //脚本语言类型(默认JavaScript) 1:JavaScript 2:lua 3:python CustomTopics []*ProductCustomTopic `json:"customTopics,optional"` //自定义topic数组 }
type ProductCustomReadReq ¶
type ProductCustomReadReq struct {
ProductID string `json:"productID"` //产品id 只读
}
type ProductCustomTopic ¶
type ProductCustomUi ¶
type ProductInfo ¶
type ProductInfo struct { CreatedTime int64 `json:"createdTime,optional,string"` //创建时间 只读 ProductID string `json:"productID,optional"` //产品id 只读 ProductName string `json:"productName,optional"` //产品名称 ProductImg string `json:"productImg,optional"` //产品图片 IsUpdateProductImg bool `json:"isUpdateProductImg,omitempty,optional"` //只有这个参数为true的时候才会更新产品图片,传参为产品图片的file path AuthMode int64 `json:"authMode,optional,range=[0:2]"` //认证方式:1:账密认证,2:秘钥认证 DeviceType int64 `json:"deviceType,optional,range=[0:3]"` CategoryID int64 `json:"categoryID,optional"` //产品品类 NetType int64 `json:"netType,optional,range=[0:8]"` //通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网 ProtocolCode string `json:"protocolCode,optional"` //协议code,默认iThings iThings,iThings-thingsboard,wumei,aliyun,huaweiyun,tuya AutoRegister int64 `json:"autoRegister,optional,range=[0:3]"` //动态注册:1:关闭,2:打开,3:打开并自动创建设备 Secret string `json:"secret,optional"` //动态注册产品秘钥 只读 TrialTime int64 `json:"trialTime,optional,string"` //试用时间(单位为天,为0不限制) Desc *string `json:"desc,optional"` //描述 Tags []*Tag `json:"tags,optional"` // 产品tag SceneMode string `json:"sceneMode,optional"` //场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景) Status int64 `json:"status,optional"` //产品状态 1:启用 2:禁用 3:开发中 ProtocolConf []*Tag `json:"protocolConf,optional,omitempty"` //协议配置 Protocol *ProtocolInfo `json:"protocol,omitempty"` Category *ProductCategory `json:"category,omitempty"` CustomUi map[string]*ProductCustomUi `json:"customUi,optional,omitempty"` //自定义ui,key是端的类型(web-client mini-client) value是以下类型的对象{version:123(版本号,只读),isUpdateUi:bool(是否更新ui),path:string(前端路径,如果需要修改,需要将isUpdateUi置为true并在这个参数中传入压缩包的filePath)} }
type ProductInfoDeleteReq ¶
type ProductInfoDeleteReq struct {
ProductID string `json:"productID"` //产品id 只读
}
type ProductInfoIndexReq ¶
type ProductInfoIndexReq struct { Page *PageInfo `json:"page,optional"` //分页信息,只获取一个则不填 ProductName string `json:"productName,optional"` //过滤产品名称 DeviceType int64 `json:"deviceType,optional,range=[0:3]"` //过滤设备类型:0:全部,1:设备,2:网关,3:子设备 DeviceTypes []int64 `json:"deviceTypes,optional"` //设备类型:1:设备,2:网关,3:子设备//设备类型:1:设备,2:网关,3:子设备 ProductIDs []string `json:"productIDs,optional"` //过滤产品id列表 Tags []*Tag `json:"tags,optional"` // key tag过滤查询,非模糊查询 为tag的名,value为tag对应的值 ProtocolCode string `json:"protocolCode,optional"` //协议code,默认iThings iThings,iThings-thingsboard,wumei,aliyun,huaweiyun,tuya WithProtocol bool `json:"withProtocol,optional"` //同时返回协议详情 WithCategory bool `json:"withCategory,optional"` //同时返回品类详情 SceneModes []string `json:"sceneModes,optional"` //场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景) SceneMode string `json:"sceneMode,optional"` //场景模式 读写类型: r(只读) rw(可读可写) none(不参与场景) Status int64 `json:"status,optional"` //产品状态 1:启用 2:禁用 3:开发中 Statuses []int64 `json:"statuses,optional"` //产品状态 1:启用 2:禁用 3:开发中 NetType int64 `json:"netType,optional,range=[0:8]"` //通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网 ProjectID int64 `json:"projectID,string,optional"` //项目id,只获取项目下有设备的 AreaID int64 `json:"areaID,string,optional"` //过滤区域下有设备的产品 CategoryIDs []int64 `json:"categoryIDs,optional"` //产品品类 }
type ProductInfoIndexResp ¶
type ProductInfoIndexResp struct { List []*ProductInfo `json:"list"` //产品信息 Total int64 `json:"total,optional"` //拥有的总数 Num int64 `json:"num,optional"` //返回的数量 }
type ProductInfoReadReq ¶
type ProductInitReq ¶
type ProductInitReq struct {
ProductIDs []string `json:"productIDs,optional"` //产品id 只读
}
type ProductRemoteConfig ¶
type ProductRemoteConfigIndexResp ¶
type ProductRemoteConfigIndexResp struct { List []*ProductRemoteConfig `json:"list"` //产品信息 Total int64 `json:"total"` //拥有的总数 }
type ProductRemoteConfigLastestReadReq ¶
type ProductRemoteConfigLastestReadReq struct {
ProductID string `json:"productID"` //产品id
}
type ProductRemoteConfigLastestReadResp ¶
type ProductRemoteConfigLastestReadResp struct {
ProductRemoteConfig
}
type ProductRemoteConfigPushAllReq ¶
type ProductRemoteConfigPushAllReq struct {
ProductID string `json:"productID"` //产品id
}
type ProductSchemaCreateReq ¶
type ProductSchemaCreateReq struct {
*ProductSchemaInfo
}
type ProductSchemaDeleteReq ¶
type ProductSchemaIndexReq ¶
type ProductSchemaIndexReq struct { Page *PageInfo `json:"page,optional"` //分页信息,只获取一个则不填 ProductID string `json:"productID"` //产品id Type int64 `json:"type,optional"` //物模型类型 1:property属性 2:event事件 3:action行为 Types []int64 `json:"types,optional"` Tag int64 `json:"tag,optional"` //过滤条件: 物模型标签 1:自定义 2:可选 3:必选 Identifiers []string `json:"identifiers,optional"` //过滤标识符列表 Name string `json:"name,optional"` IsCanSceneLinkage int64 `json:"isCanSceneLinkage,optional"` //是否可以场景联动 FuncGroup int64 `json:"funcGroup,optional"` // 功能分类: 1:普通功能 2:系统功能 UserPerm int64 `json:"userPerm,optional"` //用户权限操作: 1:r(只读) 3:rw(可读可写) PropertyMode string `json:"propertyMode,optional"` //属性类型可用 读写类型: 1:r(只读) 2:rw(可读可写) ControlMode int64 `json:"controlMode,optional"` //控制模式: 1: 可以群控,可以单控 2:只能单控 }
type ProductSchemaIndexResp ¶
type ProductSchemaIndexResp struct { List []*ProductSchemaInfo `json:"list"` //分页信息,只获取一个则不填 Total int64 `json:"total"` //总数(只有分页的时候会返回) }
type ProductSchemaInfo ¶
type ProductSchemaInfo struct { ProductID string `json:"productID,optional"` //产品id 只读 Type int64 `json:"type"` //物模型类型 1:property属性 2:event事件 3:action行为 Tag int64 `json:"tag"` //物模型标签 1:自定义 2:可选 3:必选 必选不可删除 Identifier string `json:"identifier"` //标识符 ExtendConfig string `json:"extendConfig,optional"` //拓展参数 Name *string `json:"name,optional"` //功能名称 Desc *string `json:"desc,optional"` //描述 Required int64 `json:"required,optional"` //是否必须 1:是 2:否 Affordance *string `json:"affordance,optional"` //各功能类型的详细参数定义 IsCanSceneLinkage int64 `json:"isCanSceneLinkage,optional"` //是否可以场景联动 FuncGroup int64 `json:"funcGroup,optional"` // 功能分类: 1:普通功能 2:系统功能 UserPerm int64 `json:"userPerm,optional"` //用户权限操作: 1:r(只读) 3:rw(可读可写) IsHistory int64 `json:"isHistory,optional"` // 是否存储历史记录 Order int64 `json:"order,optional"` // 排序 ControlMode int64 `json:"controlMode,optional"` //控制模式: 1: 可以群控,可以单控 2:只能单控 }
type ProductSchemaMultiCreateReq ¶
type ProductSchemaMultiCreateReq struct { ProductID string `json:"productID"` //产品id List []*ProductSchemaInfo `json:"list"` //分页信息,只获取一个则不填 }
type ProductSchemaTslReadReq ¶
type ProductSchemaTslReadReq struct {
ProductID string `json:"productID"` //产品id
}
type ProductSchemaTslReadResp ¶
type ProductSchemaTslReadResp struct {
Tsl string `json:"tsl"` //物模型tsl
}
type ProductSchemaUpdateReq ¶
type ProductSchemaUpdateReq struct {
*ProductSchemaInfo
}
type ProtocolConfigField ¶
type ProtocolConfigInfo ¶
type ProtocolInfo ¶
type ProtocolInfo struct { ID int64 `json:"id,optional"` Name string `json:"name,optional"` Code string `json:"code,optional"` // iThings,iThings-thingsboard,wumei,aliyun,huaweiyun,tuya TransProtocol string `json:"transProtocol,optional"` // 传输协议: mqtt,tcp,udp Desc string `json:"desc,optional"` Endpoints []string `json:"endpoints,optional"` EtcdKey string `json:"etcdKey,optional"` ConfigFields []*ProtocolConfigField `json:"configFields,optional"` //配置字段列表,没有可以不传 ConfigInfos []*ProtocolConfigInfo `json:"configInfos,optional"` //配置列表 }
type ProtocolInfoIndexReq ¶
type ProtocolInfoIndexResp ¶
type ProtocolInfoIndexResp struct { List []*ProtocolInfo `json:"list"` //自定义协议信息 Total int64 `json:"total,optional"` //拥有的总数 }
type SceneFlowInfo ¶
type SceneInfo ¶
type SceneInfo struct { ID int64 `json:"id,optional"` Name string `json:"name,optional"` AreaID int64 `json:"areaID,string,optional"` //项目区域id 只读 Status int64 `json:"status,optional"` //状态: 1启用 2禁用 Tag string `json:"tag,optional"` //标签 admin: 管理员 normal: 普通 IsCommon int64 `json:"isCommon,optional"` //是否是常用的 Type string `json:"type,optional"` FlowPath []*SceneFlowInfo `json:"flowPath,optional"` //执行路径 Desc string `json:"desc,optional"` CreatedTime int64 `json:"createdTime,optional"` If string `json:"if,optional"` When string `json:"when,optional"` Then string `json:"then,optional"` HeadImg string `json:"headImg,optional"` // 头像 IsUpdateHeadImg bool `json:"isUpdateHeadImg,omitempty,optional"` // 是否更新头像 Logo string `json:"logo,optional"` LastRunTime int64 `json:"lastRunTime,optional"` ProductID string `json:"productID,omitempty,optional"` DeviceName string `json:"deviceName,omitempty,optional"` DeviceAlias string `json:"deviceAlias,omitempty,optional"` //只读 DeviceMode string `json:"deviceMode,optional"` //设备模式 single:单设备 multi:多设备 Body string `json:"body,optional"` //自定义字段 UpdatedTime int64 `json:"updatedTime,optional"` }
type SceneInfoCreateReq ¶
type SceneInfoCreateReq struct {
SceneInfo
}
type SceneInfoIndexReq ¶
type SceneInfoIndexReq struct { Page *PageInfo `json:"page,optional"` //分页信息 只获取一个则不填 Name string `json:"name,optional"` //场景名模糊查询 Tag string `json:"tag,optional"` //标签 admin: 管理员 normal: 普通 AreaID int64 `json:"areaID,optional,string"` SceneIDs []int64 `json:"sceneIDs,optional"` //根据场景ID来过滤 Type string `json:"type,optional"` //触发类型 auto manual:手动触发 Status int64 `json:"status,optional"` //状态: 1启用 2禁用 AlarmID int64 `json:"alarmID,optional"` //告警id DeviceMode string `json:"deviceMode,optional"` //设备模式 ProductID string `json:"productID,optional"` //产品id DeviceName string `json:"deviceName,optional"` //设备名 HasActionType string `json:"hasActionType,optional"` //过滤有某个执行类型 IsCommon int64 `json:"isCommon,optional"` //是否是常用的 IsOnlyCore int64 `json:"isOnlyCore,optional"` //不返回if,when和then }
type SceneInfoIndexResp ¶
type SceneInfoUpdateReq ¶
type SceneInfoUpdateReq struct {
SceneInfo
}
type SceneLog ¶
type SceneLog struct { SceneID int64 `json:"sceneID,omitempty"` //场景id SceneName string `json:"sceneName,omitempty"` //场景名称 AreaID int64 `json:"areaID,omitempty"` //区域id CreatedTime int64 `json:"createdTime,omitempty"` //创建时间 秒级时间戳 只读 Status int64 `json:"status,omitempty"` // 状态(1成功 2失败) Type string `json:"type,omitempty"` //"manual":手动触发场景 "auto":自动化 Trigger *SceneLogTrigger `json:"trigger,omitempty"` //触发 Actions []*SceneLogAction `json:"actions,omitempty"` }
type SceneLogAction ¶
type SceneLogAction struct { Type string `json:"type,omitempty"` //执行类型(目前只记录设备属性控制) Status int64 `json:"status,omitempty"` // 状态(1成功 2失败) Code int64 `json:"code,omitempty"` //错误码 Msg string `json:"msg,omitempty"` //错误信息 MsgToken string `json:"msgToken,omitempty"` //调用id Delay int64 `json:"delay,omitempty"` //延时秒数 Device *SceneLogActionDevice `json:"device,omitempty"` Alarm *SceneLogActionAlarm `json:"alarm,omitempty"` Scene *LogActionScene `json:"scene,omitempty"` }
type SceneLogActionAlarm ¶
type SceneLogActionAlarm struct {
Mode string `json:"mode,omitempty"` //告警模式 trigger: 触发告警 relieve: 解除告警
}
type SceneLogActionDevice ¶
type SceneLogActionDevice struct { Type string `json:"type,omitempty"` //设备执行的类型 ProductID string `json:"productID,omitempty"` //产品ID ProductName string `json:"productName,omitempty"` //产品名称 DeviceName string `json:"deviceName,omitempty"` //设备id DeviceAlias string `json:"deviceAlias,omitempty"` //设备昵称 Values []*SceneLogActionDeviceValue `json:"values,omitempty"` //执行的值 }
type SceneLogIndexReq ¶
type SceneLogIndexResp ¶
type SceneLogTrigger ¶
type SceneLogTrigger struct { Type string `json:"type,omitempty"` //触发类型 Time int64 `json:"time"` ////触发时间,秒时间戳 Device *SceneLogTriggerDevice `json:"device,omitempty"` //设备触发类型:触发设备 }
type SceneLogTriggerDevice ¶
type SceneLogTriggerDevice struct { Type string `json:"type,omitempty"` ////触发类型 connected:上线 disConnected:下线 reportProperty:属性上报 reportEvent: 事件上报 ProductID string `json:"productID,omitempty"` //设备触发 DeviceName string `json:"deviceName,omitempty"` //设备触发 DeviceAlias string `json:"deviceAlias,omitempty"` //设备昵称 DataID string `json:"dataID,omitempty"` //触发的id DataName string `json:"dataName,omitempty"` //触发id的名字 Value string `json:"value,omitempty"` //触发的值 }
type SchemaAction ¶
type SchemaAction struct { Input []*SchemaParam `json:"input,optional"` //调用参数 Output []*SchemaParam `json:"output,optional"` //返回参数 }
type SchemaDefine ¶
type SchemaDefine struct { Type string `json:"type"` //参数类型: bool int string float timestamp array enum Mapping map[string]string `json:"mapping,omitempty"` //枚举及bool类型:bool enum Min string `json:"min,omitempty"` //数值最小值:int float Max string `json:"max,omitempty"` //数值最大值:int string float Start string `json:"start,omitempty"` //初始值:int float Step string `json:"step,omitempty"` //步长:int float Unit string `json:"unit,omitempty"` //单位:int float Specs []*SchemaSpec `json:"specs,omitempty"` //结构体: ArrayInfo *SchemaDefine `json:"arrayInfo,omitempty"` //数组:array }
type SchemaEvent ¶
type SchemaEvent struct { Type string `json:"type"` //事件类型: 信息:info 告警alert 故障:fault Params []*SchemaParam `json:"params,optional"` //事件参数 }
type SchemaParam ¶
type SchemaParam struct { Identifier string `json:"identifier"` //参数标识符 Name string `json:"name"` //参数名称 Define *SchemaDefine `json:"define,omitempty"` //参数定义 }
type SchemaProperty ¶
type SchemaProperty struct { Mode string `json:"mode,optional"` //读写类型: r(只读) rw(可读可写) Define *SchemaDefine `json:"define"` //参数定义 }
type SchemaSpec ¶
type SchemaSpec struct { Identifier string `json:"identifier"` //参数标识符 Name string `json:"name"` //参数名称 DataType *SchemaDefine `json:"dataType"` //参数定义 }
type SendOption ¶
type SlotAreaSaveReq ¶
type SlotUserSubscribeReq ¶
type UserCollectDeviceInfo ¶
type UserCollectDeviceInfo struct {
Devices []*DeviceInfo `json:"devices"`
}
type UserCollectDeviceSave ¶
type UserCollectDeviceSave struct {
Devices []*DeviceCore `json:"devices"`
}
type UserCore ¶
type UserCore struct { UserID int64 `json:"userID,string,optional"` // 用户id UserName string `json:"userName,optional"` // 用户名(唯一) Email string `json:"email,optional"` // 邮箱 Phone string `json:"phone,optional"` // 手机号 LastIP string `json:"lastIP,optional"` // 最后登录ip RegIP string `json:"regIP,optional"` // 注册ip NickName string `json:"nickName,optional"` // 用户的昵称 HeadImg string `json:"headImg,optional"` // 用户头像 CreatedTime int64 `json:"createdTime,string,optional"` // 创建时间 }
type UserDeviceShareIndexReq ¶
type UserDeviceShareIndexReq struct {}
type UserDeviceShareIndexResp ¶
type UserDeviceShareIndexResp struct {}
type UserDeviceShareInfo ¶
type UserDeviceShareInfo struct {}
type UserDeviceShareMultiDeleteReq ¶
type UserDeviceShareMultiDeleteReq struct {}
type UserDeviceShareReadReq ¶
type UserDeviceShareReadReq struct {}
type WithIDChildren ¶
type WithIDOrCode ¶
type WithProfile ¶
Click to show internal directories.
Click to hide internal directories.