### 远程控制设备通断电

*controller-event*

通断器、空开、10A-86插座、16A-86插座、10A转换器插座、16A转换器插座等单路设备的通电或断电操作

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"key1" : 1,
"key2" : 1,
"key3" : 1,
"type" : "event"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"code" : "GSCW3B-4G",
"commandName" : "controller-event",
"iccid" : "89860325422011598278",
"imei" : "866965087675317",
"key1" : 0,
"key2" : 0,
"key3" : 0,
"keyLock" : 0,
"messageId" : "",
"onState" : 1,
"resetLock" : 0,
"signal" : 16,
"source" : "command",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.1.2"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 设备自动上报频率

*device-timer-interval*

配置设备数据的定时上报参数，包括是否上报与上报频率。启用后，设备按设定频率周期上报电量、开关状态等数据至服务器。

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"messageId" : "202201241610366046",
"timerEnable" : 1,
"timerInterval" : 15,
"type" : "setting"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"code" : "GSCW3B-4G",
"commandName" : "device-timer-interval",
"iccid" : "89860325422011598278",
"imei" : "866965087675317",
"key1" : 0,
"key2" : 0,
"key3" : 0,
"keyLock" : 0,
"messageId" : "202201241610366046",
"onState" : 1,
"resetLock" : 0,
"signal" : 15,
"source" : "command",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.1.2"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 用电数据自动上报

*device-timer-task*

查看设备定时上报数据的 JSON 格式，供服务器端对接解析设备上报的数据。是否上报与上报频率由"设置数据定时上报频率"指令配置，配置后设备按周期将数据发布至约定主题（topic），设备端无订阅行为（仅发布），服务端订阅该发布主题后即可接收上报数据。

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"voltage": 238.042,
"imei": "866965087675317",
"commandName": "device-timer-interval",
"messageId": "",
"source": "auto",
"key1": 0,
"key2": 0,
"key3": 0,
"energy": 0,
"power": 0.018,
"current": 0.003
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 获取设备基础信息

*info-all*

获取设备信息一般会包含：设备通断电状态、MAC/IMEI、固件版本、设备内网IP地址、设备WIFI网络名称等信息，不同的产品返回的信息有所差异

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"type" : "info"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"code" : "GSCW3B-4G",
"commandName" : "info-all",
"iccid" : "89860325422011598278",
"imei" : "866965087675317",
"key1" : 0,
"key2" : 0,
"key3" : 0,
"keyLock" : 0,
"messageId" : "",
"onState" : 1,
"resetLock" : 0,
"signal" : 15,
"source" : "command",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.1.2"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 获取设备用电信息

*info-statistic*

获取设备采集的累积电量、实时电压、实时电流、实时功率信息，注意不同的设备数值单位有区别，取决于设备设计的精度

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"type" : "statistic"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"voltage": 237.563,
"imei": "866965087675317",
"commandName": "info-statistic",
"messageId": "",
"source": "command",
"key1": 0,
"key2": 0,
"key3": 0,
"energy": 0,
"power": 0.039,
"current": 0.003
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 查询定时通断任务

*info-timer-task-query*

查询设备已设置的定时通断电任务列表及详情。

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
　　"action" : "timerTaskQuery",
　　"messageId" : "202201241610366046",
　　"type" : "event"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
　　"action" : "timerTaskQuery",
　　"commandName" : "info-timer-task-query",
　　"imei" : "866965087675317",
　　"list" : {},
　　"messageId" : "202201241610366046",
　　"source" : "command",
　　"type" : "event"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 设置倒计时通断任务

*setting-timer-countdown*

设置倒计时任务——指定时长与到点动作（关闭/开启）。

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
　　"countdownSecond" : 10,
　　"finishCommand" :
　　{
　　　　"key1" : 0,
　　　　"key2" : 0,
　　　　"key3" : 0,
　　　　"type" : "event"
　　},
　　"messageId" : "20260520",
　　"task" : "countdown",
　　"timerInterval" : 1,
　　"type" : "setting"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
　　"commandName" : "setting-timer-countdown",
　　"countdownSecond" : 10,
　　"finishCommand" :
　　{
　　　　"key1" : 0,
　　　　"key2" : 0,
　　　　"key3" : 0,
　　　　"type" : "event"
　　},
　　"imei" : "866965087675317",
　　"messageId" : "20260520",
　　"source" : "command",
　　"task" : "countdown",
　　"timerInterval" : 1,
　　"type" : "setting"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 倒计时任务自动上报

*setting-timer-countdown-active*

查看设备倒计时状态上报的 JSON 格式定义，供服务端对接解析设备上报的倒计时状态数据。上报频率由"设置倒计时任务"指令配置，配置后设备按周期将数据发布至约定主题（topic），设备端无订阅行为（仅发布），服务端订阅该发布主题后即可接收上报数据。<br/>

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"state": 0,
"countdownSecond": 10,
"imei": "866965087675317",
"source": "auto",
"remaining": 10,
"commandName": "setting-timer-countdown-active"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 清除倒计时通断任务

*setting-timer-countdown-clear*

删除设备中已设置的所有倒计时通断电任务，删除为不可逆操作，删除后需重新设置。

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"messageId" : "202201241610366046",
"task" : "countdown-clear",
"type" : "setting"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"commandName" : "setting-timer-countdown-clear",
"imei" : "866965087675317",
"message" : "ok",
"messageId" : "202201241610366046",
"source" : "command",
"success" : true
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 清除定时通断任务

*setting-timer-delete*

删除设备中已设置的单条定时通断电任务，删除为不可逆操作，删除后需重新设置。

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"action" : "delete",
"messageId" : "202201241610366046",
"number" : 1,
"type" : "setting"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"commandName" : "setting-timer-delete",
"imei" : "866965087675317",
"message" : "ok",
"messageId" : "202201241610366046",
"source" : "command",
"success" : true
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 设置定时通断任务

*setting-timer-task*

新增或编辑定时通断电任务，设置后到点执行开启/关闭操作。

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"command" :
{
"key1" : 0,
"key2" : 0,
"key3" : 0,
"type" : "event"
},
"hour" : 11,
"minute" : 11,
"number" : 1,
"repeat" : "oneof",
"task" : "timer"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"command" :
{
"key1" : 0,
"key2" : 0,
"key3" : 0,
"type" : "event"
},
"commandName" : "setting-timer-task",
"hour" : 11,
"imei" : "866965087675317",
"minute" : 11,
"number" : 1,
"repeat" : "oneof",
"source" : "command"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 重置/恢复出厂设置

*controller-reset*

将设备恢复至出厂状态，清除全部用户数据与配置，并自动重启。

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"system" : "reset",
"type" : "setting"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"success": true,
"imei": "866965087675317",
"message": "ok",
"commandName": "controller-reset",
"source": "command"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 设备软重启

*controller-restart*

软重启后，通过指令设置的参数将生效，同时设备将重新连接Wifi/4G网络，注意设备IP地址可能发生变化

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"system" : "restart",
"type" : "setting"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"success": true,
"imei": "866965087675317",
"message": "ok",
"commandName": "controller-restart",
"source": "command"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 累计用电量清零

*energy-clear*

将设备累计用电量清零，清零后从零开始重新累计统计，仅清除累计用电量，不影响其他数据。清零为不可逆操作，清除后累计数据无法恢复！

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"system" : "energy-clear",
"type" : "setting"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"success": true,
"imei": "866965087675317",
"message": "ok",
"commandName": "energy-clear",
"source": "command"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 获取设备通信方式

*info-timer*

获取当前设备与服务端交互的通信协议及协议配置参数，目前支持MQTT、TCP Client和HTTP Server（固件版本2.0.0以上支持），设备出厂时默认接入GemeOpen厂家MQTT测试服务器，免费提供客户调试使用，如需接入自己的服务器或使用其他协议，请自行搭建服务器。

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"messageId" : "202201241610366046",
"type" : "protocol"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"clientId" : "866965087675317",
"commandName" : "info-protocol",
"messageId" : "202201241610366046",
"password" : "azmFLQJKQmFQczAOXy",
"port" : "1883",
"protocol" : "mqtt",
"publish" : "/INIT/MxCtqubWhLuj/866965087675317/subscribe",
"server" : "mqtt.smart-bird.cn",
"source" : "command",
"subcribe" : "/INIT/MxCtqubWhLuj/866965087675317/publish",
"username" : "MxCtqubWhLuj"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 设置按键重置锁

*setting--lock*

开启后设备只能通过mqtt,tcp方式重置.

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"resetLock" : 1,
"type" : "setting"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"code" : "GSCW3B-4G",
"commandName" : "setting-resetLock",
"iccid" : "89860325422011598278",
"imei" : "866965087675317",
"key1" : 0,
"key2" : 0,
"key3" : 0,
"keyLock" : 0,
"onState" : 1,
"resetLock" : 1,
"signal" : 15,
"source" : "command",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.1.2"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 设置按键控制锁

*setting-key-lock*

功能按键锁定后，设备仅能通过MQTT/TCP协议操作，例如控制开关的通断、插座的通断电，都只能通过指令操作

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"keyLock" : 1,
"type" : "setting"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"code" : "GSCW3B-4G",
"commandName" : "setting-keyLock",
"iccid" : "89860325422011598278",
"imei" : "866965087675317",
"key1" : 0,
"key2" : 0,
"key3" : 0,
"keyLock" : 1,
"onState" : 1,
"resetLock" : 0,
"signal" : 15,
"source" : "command",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.1.2"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 自定义MQTT参数

*setting-mqtt*

设备支持自定义MQTT，注意：在通过MQTT自定义MQTT信息后，需要将设备断电重启或者向设备发送重启命令才可生效。

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

### 设置上电默认状态

*setting-on-state*

配置设备断电恢复后输出的默认状态，即断电恢复瞬间设备是通电还是断电。

**向设备发送指令（服务端向设备订阅topic发送消息）**

```json

{
"onState" : 1,
"type" : "setting"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---

**设备返回信息（设备向服务端订阅topic上报消息）**

```json

{
"code" : "GSCW3B-4G",
"commandName" : "setting-onState",
"iccid" : "89860325422011598278",
"imei" : "866965087675317",
"key1" : 0,
"key2" : 0,
"key3" : 0,
"keyLock" : 0,
"onState" : 1,
"resetLock" : 0,
"signal" : 16,
"source" : "command",
"timerEnable" : 1,
"timerInterval" : 15,
"version" : "1.1.2"
}

```

#### 字段属性

---

| 字段名称 | 字段类型 | 字段说明 | 示例值 |

|------|------|------|------|

---