diff --git a/.idea/encodings.xml b/.idea/encodings.xml index af673e731ee662e09e488f58a1f8d6c1db615756..fade66b8c1f5edc35c6a06be6228556d34bc598d 100644 --- a/.idea/encodings.xml +++ b/.idea/encodings.xml @@ -3,6 +3,5 @@ - \ No newline at end of file diff --git a/.idea/jarRepositories.xml b/.idea/jarRepositories.xml index e0b7de2433c11f66506a02eb1ad4988468b6397c..b5d13eb07384bb77e3261940fce58ec8589e7848 100644 --- a/.idea/jarRepositories.xml +++ b/.idea/jarRepositories.xml @@ -1,6 +1,16 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/runConfigurations.xml b/.idea/runConfigurations.xml new file mode 100644 index 0000000000000000000000000000000000000000..797acea53eb091cf5b30518802c3073f544adeed --- /dev/null +++ b/.idea/runConfigurations.xml @@ -0,0 +1,10 @@ + + + + + + \ No newline at end of file diff --git a/pom.xml b/pom.xml index 8c922ccc4e81c15783c9a2de12bc388129823889..28331e9043853dcc2db7e85e209608a0eed3f291 100644 --- a/pom.xml +++ b/pom.xml @@ -25,6 +25,7 @@ 8 + ${project.groupId}:${project.artifactId} @@ -166,6 +167,7 @@ org.apache.maven.plugins maven-javadoc-plugin 2.9.1 + attach-javadocs @@ -175,6 +177,9 @@ + + -Xdoclint:none + false diff --git a/src/main/java/me/hekr/iotos/api/IotClient.java b/src/main/java/me/hekr/iotos/api/IotClient.java index 366cf04ef207f1ce21251a813d7e71695f4f8951..328956b64aa03cc15708535315d5843d0dd9f68a 100644 --- a/src/main/java/me/hekr/iotos/api/IotClient.java +++ b/src/main/java/me/hekr/iotos/api/IotClient.java @@ -108,7 +108,7 @@ public class IotClient { /** * 获取所有产品信息 * - * @return List + * @return 产品列表 */ public List getAllProducts() { return Pagec.getAll(100, (page, size) -> retrofitIotService.getProduct(page, size)); @@ -117,8 +117,8 @@ public class IotClient { /** * 创建设备 * - * @param addReq - * @return + * @param addReq 设备信息 + * @return 添加的设备信息 */ public DeviceApiDTO createDevice(DeviceAddReq addReq) { return execute(retrofitIotService.createDevice(addReq)); @@ -236,7 +236,8 @@ public class IotClient { } /** - * 获取鉴权信息 + * 获取鉴权信息 * * @return LoginRsp */ @@ -247,7 +248,8 @@ public class IotClient { /** * 获取产品列表 * - *

获取产品列表 + *

获取产品列表 * * @param page 当前页,从0开始 * @param size 分页大小,最大100,最小1 @@ -260,7 +262,8 @@ public class IotClient { /** * 获取批次下所有设备 * - *

获取批次下所有设备 + *

获取批次下所有设备 * * @param pk 产品PK * @param batchName 批次名称 @@ -273,7 +276,8 @@ public class IotClient { /** * 更改设备名称 * - *

更改设备名称 + *

更改设备名称 * * @param req 设备信息(pk,devId,name) */ @@ -281,11 +285,12 @@ public class IotClient { execute(retrofitIotService.updateName(req)); } + + /** * 获取鉴权信息 - * - *

获取鉴权信息 - * + *

获取鉴权信息 + * @param req 设备信息(pk,devId,name) * @return 鉴权信息 */ public List getDeviceStatus(DevIdListReq req) { @@ -295,7 +300,7 @@ public class IotClient { /** * 新增设备 * - *

新增设备 + *

新增设备 * * @param reqDto 设备信息(pk,devId,name) * @return 设备信息 @@ -307,7 +312,7 @@ public class IotClient { /** * 导入设备 * - *

导入设备 + *

导入设备 * * @param devIdListReq (产品PK和设备ID列表) * @return 包含批次名称和添加数量 @@ -319,7 +324,7 @@ public class IotClient { /** * 查询设备列表 * - *

查询设备列表 + *

查询设备列表 * * @param pk 产品PK * @param keyword 搜索关键词 @@ -337,7 +342,7 @@ public class IotClient { /** * 查询设备详情 * - *

查询设备详情 + *

查询设备详情 * * @param pk 产品PK * @param devId 设备ID @@ -350,7 +355,7 @@ public class IotClient { /** * 查询设备影子 * - *

查询设备影子 + *

查询设备影子 * * @param pk 产品PK * @param devId 设备ID @@ -363,7 +368,7 @@ public class IotClient { /** * 删除设备 * - *

删除设备 + *

删除设备 * * @param pk 产品PK * @param devId 设备ID @@ -376,7 +381,7 @@ public class IotClient { /** * 查询历史上下行数 * - *

查询历史上下行数 + *

查询历史上下行数据 * * @param pk 产品PK * @param devId 设备ID @@ -396,7 +401,7 @@ public class IotClient { /** * 下发控制命令 * - *

下发控制命令 + *

下发控制命令 * * @param pk 产品PK * @param devId 设备ID @@ -410,7 +415,7 @@ public class IotClient { /** * 查询命令状态 * - *

查询命令状态 + *

查询命令状态 * * @param messageId 所查询命令的ID * @return 命令信息 @@ -422,7 +427,7 @@ public class IotClient { /** * 查询历史控制命令 * - *

查询历史控制命令 + *

查询历史控制命令 * * @param page 当前页面,最小0 * @param size 分页大小,最大100,最小0 @@ -440,7 +445,7 @@ public class IotClient { /** * 网关添加子设备 * - *

网关添加子设备 + *

网关添加子设备 * * @param pk 产品PK * @param devId 设备ID @@ -454,8 +459,6 @@ public class IotClient { /** * 网关删除子设备 * - *

网关删除子设备 - * * @param pk 产品PK * @param devId 设备ID * @param sub 子设备 @@ -465,6 +468,9 @@ public class IotClient { return execute(retrofitIotService.delTopo(pk, devId, sub)); } + /** + * + */ @Data public static class Builder { private String host; @@ -473,25 +479,46 @@ public class IotClient { private String as; private Level level = Level.HEADERS; - /** 地址,如 http://10.1.1.100:8081 */ + + /** + * 地址,如 http://10.1.1.100:8081 + * + * @param host 地址 + * @return Builder + */ public Builder host(String host) { this.host = host; return this; } - /** 前缀,比如 /iot-api */ + /** + * 前缀,比如 /iot-api + * + * @param prefix 前缀 + * @return Builder + */ public Builder prefix(String prefix) { this.prefix = prefix; return this; } - /** accessKey */ + /** + * accessKey + * + * @param ak accessKey + * @return Builder + */ public Builder ak(String ak) { this.ak = ak; return this; } - /** accessSecret */ + /** + * accessSecret + * + * @param as accessSecret + * @return Builder + */ public Builder as(String as) { this.as = as; return this; diff --git a/src/main/java/me/hekr/iotos/api/dto/CloudSendMsgDTO.java b/src/main/java/me/hekr/iotos/api/dto/CloudSendMsgDTO.java index 5746c6f30d30e927f86d77d8ac5de0227f19a9e2..75c279a46e49858b3e9b37bdc3cb6f00ea6ca8ce 100644 --- a/src/main/java/me/hekr/iotos/api/dto/CloudSendMsgDTO.java +++ b/src/main/java/me/hekr/iotos/api/dto/CloudSendMsgDTO.java @@ -1,13 +1,8 @@ package me.hekr.iotos.api.dto; import java.util.Date; -import lombok.Data; -/** - * @author :jiatao - * @date :2019-12-12 - */ -@Data + public class CloudSendMsgDTO { private String messageId; /*错误码*/ @@ -16,4 +11,36 @@ public class CloudSendMsgDTO { private String desc; /*消息创建时间*/ private Date createTime; + + public String getMessageId() { + return messageId; + } + + public void setMessageId(String messageId) { + this.messageId = messageId; + } + + public int getCode() { + return code; + } + + public void setCode(int code) { + this.code = code; + } + + public String getDesc() { + return desc; + } + + public void setDesc(String desc) { + this.desc = desc; + } + + public Date getCreateTime() { + return createTime; + } + + public void setCreateTime(Date createTime) { + this.createTime = createTime; + } } diff --git a/src/main/java/me/hekr/iotos/api/dto/DeviceAggPacket.java b/src/main/java/me/hekr/iotos/api/dto/DeviceAggPacket.java index 9b58437d815dbfc95b4f8aca5c04d2cd8d2c2ce3..08277465c2e8ac36545956cd3974e0c8f4041ebe 100644 --- a/src/main/java/me/hekr/iotos/api/dto/DeviceAggPacket.java +++ b/src/main/java/me/hekr/iotos/api/dto/DeviceAggPacket.java @@ -4,10 +4,7 @@ import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; -/** - * @author :jiatao - * @date :2019-12-25 - */ + @Data @AllArgsConstructor @NoArgsConstructor diff --git a/src/main/java/me/hekr/iotos/api/dto/DeviceAggPacketResp.java b/src/main/java/me/hekr/iotos/api/dto/DeviceAggPacketResp.java index b129f708464f6bc09e4bb8142a2afd1cf1a2e57f..c9cbb5639ee38f8a1e83e662474aa3fc3f496951 100644 --- a/src/main/java/me/hekr/iotos/api/dto/DeviceAggPacketResp.java +++ b/src/main/java/me/hekr/iotos/api/dto/DeviceAggPacketResp.java @@ -5,10 +5,7 @@ import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; -/** - * @author :jiatao - * @date :2019-12-30 - */ + @Data @AllArgsConstructor @NoArgsConstructor diff --git a/src/main/java/me/hekr/iotos/api/dto/LoginRsp.java b/src/main/java/me/hekr/iotos/api/dto/LoginRsp.java index 9909fd599d30d95c6a5af245fa9cd0a37f54e945..c08d0e3dd550f30134e004e86912b4ce8ddaeb42 100644 --- a/src/main/java/me/hekr/iotos/api/dto/LoginRsp.java +++ b/src/main/java/me/hekr/iotos/api/dto/LoginRsp.java @@ -3,10 +3,7 @@ package me.hekr.iotos.api.dto; import java.io.Serializable; import lombok.Data; -/** - * @author: zeyang.li - * @create: 2019-09-05 - */ + @Data public class LoginRsp implements Serializable { diff --git a/src/main/java/me/hekr/iotos/api/service/RetrofitIotService.java b/src/main/java/me/hekr/iotos/api/service/RetrofitIotService.java index 5cdd15a510b237fc9677ed90b6a4706345a31b34..c8a4edd4e54577840045ca918badd4b2ba2fa9da 100644 --- a/src/main/java/me/hekr/iotos/api/service/RetrofitIotService.java +++ b/src/main/java/me/hekr/iotos/api/service/RetrofitIotService.java @@ -37,22 +37,22 @@ public interface RetrofitIotService { /** * 获取产品列表 * - *

获取产品列表 + *

获取产品列表 * * @param page 当前页,从0开始 * @param size 分页大小,最大100,最小1 - * @return + * @return 分页产品 */ @GET("/product") Call> getProduct(@Query("page") int page, @Query("size") int size); /** - * 获取物模型 + * 获取产品物模型 * - *

产品物模型查询 * * @param pk 产品PK - * @return + * @return 物模型 */ @GET("/model/protocol/{pk}") Call getProtocol(@Path("pk") String pk); @@ -60,10 +60,9 @@ public interface RetrofitIotService { /** * 新增设备 * - *

新增设备 + * @param addReq 产品信息 + * @return 添加的设备信息 */ @POST("/api/device/addDevice") Call createDevice(@Body DeviceAddReq addReq); @@ -71,7 +70,7 @@ public interface RetrofitIotService { /** * 获取批次下所有设备 * - *

获取批次下所有设备 + *

获取批次下所有设备 * * @param pk 产品PK * @param batchName 批次名称 @@ -84,7 +83,7 @@ public interface RetrofitIotService { /** * 更改设备名称 * - *

更改设备名称 + *

更改设备名称 * * @param req 设备信息(pk,devId,name) * @return 空 @@ -95,7 +94,7 @@ public interface RetrofitIotService { /** * 查询设备详情 * - *

查询设备详情 + *

查询设备详情 * * @param pk 产品PK * @param devId 设备ID @@ -107,7 +106,7 @@ public interface RetrofitIotService { /** * 批量查询状态 * - *

批量查询状态 + *

批量查询状态 * * @param req 设备信息(pk,devId,name) * @return 设备信息列表 @@ -118,7 +117,7 @@ public interface RetrofitIotService { /** * 获取鉴权信息 * - *

获取鉴权信息 + *

获取鉴权信息 * * @return 鉴权信息 */ @@ -128,7 +127,7 @@ public interface RetrofitIotService { /** * 新增设备 * - *

新增设备 + *

新增设备 * * @param reqDto 设备信息(pk,devId,name) * @return 设备信息 @@ -139,7 +138,7 @@ public interface RetrofitIotService { /** * 导入设备 * - *

导入设备 + *

导入设备 * * @param devIdListReq (产品PK和设备ID列表) * @return 包含批次名称和添加数量 @@ -150,7 +149,7 @@ public interface RetrofitIotService { /** * 查询设备列表 * - *

查询设备列表 + *

查询设备列表 * * @param pk 产品PK * @param keyword 搜索关键词 @@ -172,7 +171,7 @@ public interface RetrofitIotService { /** * 查询设备详情 * - *

查询设备详情 + *

查询设备详情 * * @param pk 产品PK * @param devId 设备ID @@ -184,7 +183,7 @@ public interface RetrofitIotService { /** * 查询设备影子 * - *

查询设备影子 + *

查询设备影子 * * @param pk 产品PK * @param devId 设备ID @@ -196,11 +195,12 @@ public interface RetrofitIotService { /** * 删除设备 * - *

删除设备 + *

删除设备 * * @param pk 产品PK * @param devId 设备ID * @param delSnapshot 是否删除设备影子 + * @return 空 */ @DELETE("/api/device/delDevice/{pk}/{devId}") Call delDevice( @@ -211,7 +211,7 @@ public interface RetrofitIotService { /** * 查询历史上下行数 * - *

查询历史上下行数 + *

查询历史上下行数 * * @param pk 产品PK * @param devId 设备ID @@ -235,7 +235,7 @@ public interface RetrofitIotService { /** * 下发控制命令 * - *

下发控制命令 + *

下发控制命令 * * @param pk 产品PK * @param devId 设备ID @@ -249,7 +249,7 @@ public interface RetrofitIotService { /** * 查询命令状态 * - *

查询命令状态 + *

查询命令状态 * * @param messageId 所查询命令的ID * @return 命令信息 @@ -260,7 +260,7 @@ public interface RetrofitIotService { /** * 查询历史控制命令 * - *

查询历史控制命令 + *

查询历史控制命令 * * @param page 当前页面,最小0 * @param size 分页大小,最大100,最小0 @@ -282,7 +282,7 @@ public interface RetrofitIotService { /** * 网关添加子设备 * - *

网关添加子设备 + *

网关添加子设备 * * @param pk 产品PK * @param devId 设备ID @@ -295,7 +295,6 @@ public interface RetrofitIotService { /** * 网关删除子设备 * - *

网关删除子设备 * * @param pk 产品PK * @param devId 设备ID