设备管理增加额度容量字段;

首页API文档;
This commit is contained in:
yu 2024-10-16 16:58:31 +08:00
parent e8c8b4dad9
commit 78f5af7e3e
5 changed files with 446 additions and 0 deletions

View File

@ -106,5 +106,9 @@ public class SysEquipmentDto {
*/ */
private Integer standard; private Integer standard;
/**
* 额定容量
*/
private Double nominalCapacity;
} }

View File

@ -113,4 +113,9 @@ public class SysEquipmentVo{
*/ */
private Integer standard; private Integer standard;
/**
* 额定容量
*/
private Double nominalCapacity;
} }

View File

@ -131,4 +131,10 @@ public class SysEquipment extends BaseEntity {
*/ */
@TableField(value = "standard") @TableField(value = "standard")
private Integer standard; private Integer standard;
/**
* 额定容量
*/
@TableField(value = "nominal_capacity")
private Double nominalCapacity;
} }

View File

@ -19,6 +19,7 @@
<result property="iotModelId" column="iot_model_id" jdbcType="BIGINT"/> <result property="iotModelId" column="iot_model_id" jdbcType="BIGINT"/>
<result property="belongLine" column="belong_line" jdbcType="VARCHAR"/> <result property="belongLine" column="belong_line" jdbcType="VARCHAR"/>
<result property="standard" column="standard" jdbcType="INTEGER"/> <result property="standard" column="standard" jdbcType="INTEGER"/>
<result property="nominalCapacity" column="nominal_capacity" jdbcType="DOUBLE"/>
</resultMap> </resultMap>
<resultMap type="com.das.modules.equipment.domain.vo.SysEquipmentVo" id="SysEquipmentListMap"> <resultMap type="com.das.modules.equipment.domain.vo.SysEquipmentVo" id="SysEquipmentListMap">

430
docs/api/home.md Normal file
View File

@ -0,0 +1,430 @@
# 首页
## API接口一览表
| 接口分类 | 接口描述 | API接口 | 权限 |
|--------|-------------|------------------------------| ---------------------------- |
| 2.1 首页 | 2.1.1风场概况 | /api/home/windFarmOverview | |
| | 2.1.2今日运行状态 | /api/home/currentDayStatus | |
| | 2.1.3功率趋势 | /api/home/powerTrends | |
| | 2.1.4风机矩阵 | /api/home/windTurbineMatrix | |
| | 2.1.5发电量概况 | /api/home/generationOverview | |
| | 2.1.6发电量趋势 | /api/home/generationTrend | |
| | 2.1.7实时告警 | /api/home/realTimeAlert | |
| | 2.1.8实时告警确认 | /api/home/realTimeAlertConfirm | |
### 2.1 首页相关接口
#### 2.1.1 风场概况
POST 请求接口
> /api/home/windFarmOverview
请求参数
```json
{
"requestTime":"2024-10-16"
}
```
入参描述
| 参数名 | 参数类型 | 可选 | 描述 |
| ------------ | -------- | ---- |------|
| requestTime | String | yes | 请求时间 |
注:请求时间默认为:昨日时间
返回报文
```json
{
"code": 200,
"msg": "操作成功",
"success": true,
"data":
{
"power": 56.2,
"windSpeed": 45.3,
"dailyUsageHours": 20,
"monthlyUsageHours": 78
}
}
```
返参描述
| 参数名 | 参数类型 | 可选 | 描述 |
| ------------- |---------| ---- |--------|
| power | Double | 否 | 功率 |
| windSpeed | Double | 否 | 风速 |
| dailyUsageHours | Integer | 否 | 日利用小时数 |
| monthlyUsageHours | Integer | 否 | 月利用小时数 |
#### 2.1.2 今日运行状态
POST 请求接口
> /api/home/currentDayStatus
请求参数
```json
{
"requestTime":"2024-10-16"
}
```
入参描述
| 参数名 | 参数类型 | 可选 | 描述 |
| ------------ | -------- | ---- |------|
| requestTime | String | yes | 请求时间 |
返回报文
```json
{
"code": 200,
"msg": "操作成功",
"success": true,
"data":
{
"windTurbineNum": 40,
"installedCapacity": 45.32,
"runCapacity": 20.2,
"runNum": 78,
"standbyCapacity": 63.2,
"standbyNum": 35,
"faultCapacity": 56.4,
"faultNum": 53,
"offlineCapacity": 16.4,
"offlineNum": 20
}
}
```
返参描述
| 参数名 | 参数类型 | 可选 | 描述 |
| ------------- |---------| ---- |------|
| windTurbineNum | Integer | 否 | 风机台数 |
| installedCapacity | Double | 否 | 装机容量 |
| runCapacity | Double | 否 | 运行容量 |
| runNum | Integer | 否 | 运行台数 |
| standbyCapacity | Double | 否 | 待机容量 |
| standbyNum | Integer | 否 | 待机台数 |
| faultCapacity | Double | 否 | 故障容量 |
| faultNum | Integer | 否 | 故障台数 |
| offlineCapacity | Double | 否 | 离线容量 |
| offlineNum | Integer | 否 | 离线台数 |
#### 2.1.3 功率趋势
POST 请求接口
> /api/home/powerTrends
请求参数
```json
{
"requestTime":"2024-10-16"
}
```
入参描述
| 参数名 | 参数类型 | 可选 | 描述 |
| ------------ | -------- | ---- |------|
| requestTime | String | yes | 请求时间 |
注:请求时间默认为:昨日时间
返回报文
```json
{
"code": 200,
"msg": "操作成功",
"success": true,
"data": [
{
"power": 12.6,
"windSpeed": 56.3,
"windTurbine": "GDWT00001"
},
{
"power": 10.6,
"windSpeed": 16.3,
"windTurbine": "GDWT00002"
}
]
}
```
返参描述
| 参数名 | 参数类型 | 可选 | 描述 |
|-------------|--------| ---- |------|
| power | Double | 否 | 功率 |
| windSpeed | Double | 否 | 风速 |
| windTurbine | String | 否 | 风机编码 |
#### 2.1.4 风机矩阵
POST 请求接口
> /api/home/windTurbineMatrix
请求参数
```json
{
"requestTime":"2024-10-16"
}
```
入参描述
| 参数名 | 参数类型 | 可选 | 描述 |
| ------------ | -------- | ---- |------|
| requestTime | String | yes | 请求时间 |
注:请求时间默认为:昨日时间
返回报文
```json
{
"code": 200,
"msg": "操作成功",
"success": true,
"data": [
{
"power": 12.6,
"windSpeed": 56.3,
"dayGeneration": 56.2,
"windStatus": "并网",
"standard": 1,
"windTurbine": "GDWT00001"
},
{
"power": 12.6,
"windSpeed": 56.3,
"dayGeneration": 56.2,
"windStatus": "待机",
"standard": 1,
"windTurbine": "GDWT00002"
}
]
}
```
返参描述
| 参数名 | 参数类型 | 可选 | 描述 |
|-------------|---------| ---- |---------|
| power | Double | 否 | 功率 |
| windSpeed | Double | 否 | 风速 |
| dayGeneration | Double | 否 | 日发电量 |
| windStatus | String | 否 | 风机状态 |
| standard | Integer | 否 | 是否为标杆机组 |
| windTurbine | String | 否 | 风机编码 |
#### 2.1.5 发电量概况
POST 请求接口
> /api/home/generationOverview
请求参数
```json
{
"requestTime":"2024-10-16"
}
```
入参描述
| 参数名 | 参数类型 | 可选 | 描述 |
| ------------ | -------- | ---- |------|
| requestTime | String | yes | 请求时间 |
注:请求时间默认为:昨日时间
返回报文
```json
{
"code": 200,
"msg": "操作成功",
"success": true,
"data":
{
"dayGeneration": 56.2,
"monthGeneration": 60.2,
"yearGeneration": 200.6,
"totalGeneration": 500.6
}
}
```
返参描述
| 参数名 | 参数类型 | 可选 | 描述 |
|-------------|---------| ---- |------|
| dayGeneration | Double | 否 | 日发电量 |
| monthGeneration | Double | 否 | 月发电量 |
| yearGeneration | Double | 否 | 年发电量 |
| totalGeneration | Double | 否 | 总发电量 |
#### 2.1.6 发电量趋势
POST 请求接口
> /api/home/generationTrend
请求参数
```json
{
"timeType":"日"
}
```
入参描述
| 参数名 | 参数类型 | 可选 | 描述 |
| ------------ | -------- | ---- |------|
| timeType | String | yes | 时间类型 |
注:时间类型:日/月
返回报文
```json
{
"code": 200,
"msg": "操作成功",
"success": true,
"data": [
{
"currentPeriod": 56.3,
"samePeriod": 63.5,
"generationTime": "2024-10-01"
},
{
"currentPeriod": 66.3,
"samePeriod": 73.5,
"generationTime": "2024-10-02"
}
]
}
```
返参描述
| 参数名 | 参数类型 | 可选 | 描述 |
|-------------|---------| ---- |-------|
| currentPeriod | Double | 否 | 本期 |
| samePeriod | Double | 否 | 同期 |
| generationTime | Double | 否 | 发电量时间 |
#### 2.1.7 实时告警
POST 请求接口
> /api/home/realTimeAlert
请求参数
返回报文
```json
{
"code": 200,
"msg": "操作成功",
"success": true,
"data": [
{
"alertTime": "2024-10-16 12:16:42",
"windTurbine": "SC-01",
"alertContent": "故障"
},
{
"alertTime": "2024-10-16 12:16:42",
"windTurbine": "SC-01",
"alertContent": "待机"
}
]
}
```
返参描述
| 参数名 | 参数类型 | 可选 | 描述 |
|-------------|--------| ---- |------|
| alertTime | String | 否 | 告警时间 |
| windTurbine | String | 否 | 风机编码 |
| alertContent | String | 否 | 告警内容 |
#### 2.1.8 实时告警-确认
POST 请求接口
> /api/home/realTimeAlertConfirm
请求参数
```json
{
"windTurbine":"SC-01"
}
```
入参描述
| 参数名 | 参数类型 | 可选 | 描述 |
| ------------ | -------- | ---- |------|
| windTurbine | String | yes | 风机编码 |
返回报文
```json
{
"code": 200,
"msg": "操作成功",
"success": true,
"data": [
]
}
```
返参描述
| 参数名 | 参数类型 | 可选 | 描述 |
|-------------|---------| ---- |-------|