1. 剔除掉多余的文档以及标记
This commit is contained in:
chenbowen
@@ -12,7 +12,7 @@
|
||||
<packaging>jar</packaging>
|
||||
|
||||
<name>${project.artifactId}</name>
|
||||
<!-- TODO 芋艿：需要在整理下，特别是 PF4J -->
|
||||
<!-- TODO ZT：需要在整理下，特别是 PF4J -->
|
||||
<description>
|
||||
物联网 模块 API，暴露给其它模块调用
|
||||
</description>
|
||||
|
||||
@@ -44,7 +44,7 @@ public interface IotDeviceUpstreamApi {
|
||||
@PostMapping(PREFIX + "/report-event")
|
||||
CommonResult<Boolean> reportDeviceEvent(@Valid @RequestBody IotDeviceEventReportReqDTO reportReqDTO);
|
||||
|
||||
// TODO @芋艿：这个需要 plugins 接入下
|
||||
// TODO @ZT：这个需要 plugins 接入下
|
||||
/**
|
||||
* 注册设备
|
||||
*
|
||||
@@ -53,7 +53,7 @@ public interface IotDeviceUpstreamApi {
|
||||
@PostMapping(PREFIX + "/register")
|
||||
CommonResult<Boolean> registerDevice(@Valid @RequestBody IotDeviceRegisterReqDTO registerReqDTO);
|
||||
|
||||
// TODO @芋艿：这个需要 plugins 接入下
|
||||
// TODO @ZT：这个需要 plugins 接入下
|
||||
/**
|
||||
* 注册子设备
|
||||
*
|
||||
@@ -62,7 +62,7 @@ public interface IotDeviceUpstreamApi {
|
||||
@PostMapping(PREFIX + "/register-sub")
|
||||
CommonResult<Boolean> registerSubDevice(@Valid @RequestBody IotDeviceRegisterSubReqDTO registerReqDTO);
|
||||
|
||||
// TODO @芋艿：这个需要 plugins 接入下
|
||||
// TODO @ZT：这个需要 plugins 接入下
|
||||
/**
|
||||
* 注册设备拓扑
|
||||
*
|
||||
@@ -71,7 +71,7 @@ public interface IotDeviceUpstreamApi {
|
||||
@PostMapping(PREFIX + "/add-topology")
|
||||
CommonResult<Boolean> addDeviceTopology(@Valid @RequestBody IotDeviceTopologyAddReqDTO addReqDTO);
|
||||
|
||||
// TODO @芋艿：考虑 http 认证
|
||||
// TODO @ZT：考虑 http 认证
|
||||
/**
|
||||
* 认证 Emqx 连接
|
||||
*
|
||||
|
||||
@@ -5,8 +5,8 @@ import lombok.Data;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
// TODO @芋艿：从 server => plugin => device 是否有必要？从阿里云 iot 来看，没有这个功能？！
|
||||
// TODO @芋艿：是不是改成 read 更好？在看看阿里云的 topic 设计
|
||||
// TODO @ZT：从 server => plugin => device 是否有必要？从阿里云 iot 来看，没有这个功能？！
|
||||
// TODO @ZT：是不是改成 read 更好？在看看阿里云的 topic 设计
|
||||
/**
|
||||
* IoT 设备【属性】获取 Request DTO
|
||||
*
|
||||
|
||||
@@ -3,8 +3,8 @@ package com.zt.plat.module.iot.api.device.dto.control.upstream;
|
||||
import jakarta.validation.constraints.NotEmpty;
|
||||
import lombok.Data;
|
||||
|
||||
// TODO @芋艿：要不要继承 IotDeviceUpstreamAbstractReqDTO
|
||||
// TODO @芋艿：@haohao：后续其它认证的设计
|
||||
// TODO @ZT：要不要继承 IotDeviceUpstreamAbstractReqDTO
|
||||
// TODO @ZT：@haohao：后续其它认证的设计
|
||||
/**
|
||||
* IoT 认证 Emqx 连接 Request DTO
|
||||
*
|
||||
|
||||
@@ -2,7 +2,7 @@ package com.zt.plat.module.iot.api.device.dto.control.upstream;
|
||||
|
||||
import lombok.Data;
|
||||
|
||||
// TODO @芋艿：待实现：/ota/${productKey}/${deviceName}/progress
|
||||
// TODO @ZT：待实现：/ota/${productKey}/${deviceName}/progress
|
||||
/**
|
||||
* IoT 设备【OTA】升级进度 Request DTO（上报更新固件进度）
|
||||
*
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
package com.zt.plat.module.iot.api.device.dto.control.upstream;
|
||||
|
||||
// TODO @芋艿：待实现：/ota/${productKey}/${deviceName}/pull
|
||||
// TODO @ZT：待实现：/ota/${productKey}/${deviceName}/pull
|
||||
/**
|
||||
* IoT 设备【OTA】升级下拉 Request DTO（拉取固件更新）
|
||||
*
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
package com.zt.plat.module.iot.api.device.dto.control.upstream;
|
||||
|
||||
// TODO @芋艿：待实现：/ota/${productKey}/${deviceName}/report
|
||||
// TODO @ZT：待实现：/ota/${productKey}/${deviceName}/report
|
||||
/**
|
||||
* IoT 设备【OTA】上报 Request DTO（上报固件版本）
|
||||
*
|
||||
|
||||
@@ -13,7 +13,7 @@ import java.util.List;
|
||||
@Data
|
||||
public class IotDeviceRegisterSubReqDTO extends IotDeviceUpstreamAbstractReqDTO {
|
||||
|
||||
// TODO @芋艿：看看要不要优化命名
|
||||
// TODO @ZT：看看要不要优化命名
|
||||
/**
|
||||
* 子设备数组
|
||||
*/
|
||||
|
||||
@@ -5,14 +5,14 @@ import lombok.Data;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
// TODO @芋艿：要写清楚，是来自设备网关，还是设备。
|
||||
// TODO @ZT：要写清楚，是来自设备网关，还是设备。
|
||||
/**
|
||||
* IoT 设备【拓扑】添加 Request DTO
|
||||
*/
|
||||
@Data
|
||||
public class IotDeviceTopologyAddReqDTO extends IotDeviceUpstreamAbstractReqDTO {
|
||||
|
||||
// TODO @芋艿：看看要不要优化命名
|
||||
// TODO @ZT：看看要不要优化命名
|
||||
/**
|
||||
* 子设备数组
|
||||
*/
|
||||
@@ -37,7 +37,7 @@ public class IotDeviceTopologyAddReqDTO extends IotDeviceUpstreamAbstractReqDTO
|
||||
@NotEmpty(message = "设备名称不能为空")
|
||||
private String deviceName;
|
||||
|
||||
// TODO @芋艿：阿里云还有 sign 签名
|
||||
// TODO @ZT：阿里云还有 sign 签名
|
||||
|
||||
}
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/**
|
||||
* TODO 芋艿：占位
|
||||
* TODO ZT：占位
|
||||
*/
|
||||
package com.zt.plat.module.iot.api.device.dto;
|
||||
@@ -1,6 +1,6 @@
|
||||
/**
|
||||
* 占位
|
||||
*
|
||||
* TODO 芋艿：后续删除
|
||||
* TODO ZT：后续删除
|
||||
*/
|
||||
package com.zt.plat.module.iot.api;
|
||||
|
||||
@@ -3,7 +3,7 @@ package com.zt.plat.module.iot.enums.device;
|
||||
import lombok.Getter;
|
||||
import lombok.RequiredArgsConstructor;
|
||||
|
||||
// TODO @芋艿：需要添加对应的 DTO，以及上下行的链路，网关、网关服务、设备等
|
||||
// TODO @ZT：需要添加对应的 DTO，以及上下行的链路，网关、网关服务、设备等
|
||||
/**
|
||||
* IoT 设备消息标识符枚举
|
||||
*/
|
||||
@@ -11,18 +11,18 @@ import lombok.RequiredArgsConstructor;
|
||||
@RequiredArgsConstructor
|
||||
public enum IotDeviceMessageIdentifierEnum {
|
||||
|
||||
PROPERTY_GET("get"), // 下行 TODO 芋艿：【讨论】貌似这个“上行”更合理？device 主动拉取配置。和 IotDevicePropertyGetReqDTO 一样的配置
|
||||
PROPERTY_GET("get"), // 下行 TODO ZT：【讨论】貌似这个“上行”更合理？device 主动拉取配置。和 IotDevicePropertyGetReqDTO 一样的配置
|
||||
PROPERTY_SET("set"), // 下行
|
||||
PROPERTY_REPORT("report"), // 上行
|
||||
|
||||
STATE_ONLINE("online"), // 上行
|
||||
STATE_OFFLINE("offline"), // 上行
|
||||
|
||||
CONFIG_GET("get"), // 上行 TODO 芋艿：【讨论】暂时没有上行的场景
|
||||
CONFIG_GET("get"), // 上行 TODO ZT：【讨论】暂时没有上行的场景
|
||||
CONFIG_SET("set"), // 下行
|
||||
|
||||
SERVICE_INVOKE("${identifier}"), // 下行
|
||||
SERVICE_REPLY_SUFFIX("_reply"), // 芋艿：TODO 芋艿：【讨论】上行 or 下行
|
||||
SERVICE_REPLY_SUFFIX("_reply"), // ZT：TODO ZT：【讨论】上行 or 下行
|
||||
|
||||
OTA_UPGRADE("upgrade"), // 下行
|
||||
OTA_PULL("pull"), // 上行
|
||||
|
||||
Reference in New Issue
Block a user