From 05683f2b2bdbdbe21cf17ad523c21ab338bd1c54 Mon Sep 17 00:00:00 2001
From: wuxw <928255095@qq.com>
Date: 星期二, 19 七月 2022 21:49:55 +0800
Subject: [PATCH] 优化添加设备 功能

---
 docs/api/machine.md |  243 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 241 insertions(+), 2 deletions(-)

diff --git a/docs/api/machine.md b/docs/api/machine.md
old mode 100644
new mode 100755
index f2e17d1..bd78df4
--- a/docs/api/machine.md
+++ b/docs/api/machine.md
@@ -1,14 +1,252 @@
-# 璁惧鎺ュ彛绫�
+# HC灏忓尯绠＄悊绯荤粺瀵瑰璁惧鐩稿叧鎺ュ彛
 
 ## 璇存槑
 
 鏂囨。璇存槑璁惧鐩稿叧鎺ュ彛鍗忚
 
+HC灏忓尯绠＄悊绯荤粺婧愮爜鑾峰彇 https://gitee.com/wuxw7/MicroCommunity
+
+## 涓氫富鑾峰彇瀵瑰簲璁惧
+
+璇存槑锛氭煡璇笟涓诲彲浠ュ紑闂ㄨ澶�
+
+璇锋眰鏂瑰紡锛� GET
+
+璇锋眰鍦板潃锛�/api/owner.listOwnerMachines
+
+璇锋眰鍙傛暟锛�
+
+| 鍚嶇О | 绫诲瀷 | 鏄惁蹇呭～ | 绀轰緥鍊� | 鎻忚堪 |
+| :----:| :----: | :----: | :----: | :----: |
+| memberId | String | 鏄� | 772020123183100051 | 涓氫富ID |
+| communityId | String | 鏄� | 2020122471920846 | 灏忓尯ID |
+
+璇锋眰绀轰緥锛�
+```url
+
+http://ip:port/api/owner.listOwnerMachines?memberId=772020123183100051&communityId=2020122471920846
+
+```
+
+杩斿洖鍙傛暟锛�
+
+| 鍚嶇О | 绫诲瀷 | 鏄惁蹇呭～ | 绀轰緥鍊� | 鎻忚堪 |
+| :----:| :----: | :----: | :----: | :----: |
+| direction | String | 鏄� | 3306 | 杩涘満 |
+| directionName | String | 鏄� | 杩涘満 | 涓枃鎻忚堪 |
+| heartbeatTime | String | 鏄� | 2020-12-31 18:06:40 | 璁惧鏈�杩戝績璺虫椂闂� |
+| locationObjId | String | 鏄� | 2020122471920846 | 浣嶇疆ID |
+| locationObjName | String | 鏄� | iot_灏忓尯 浣嶇疆3 | 浣嶇疆璇存槑 |
+| machineCode | String | 鏄� | 1368371 | 璁惧缂栫爜 |
+| machineId | String | 鏄� | 892020122872730977 | 璁惧ID |
+| machineIp | String | 鍚� | 192.168.1.1 | 璁惧IP |
+| machineMac | String | 鍚� | 11:11:11:11 | 璁惧mac |
+| machineName | String | 鏄� | 鍘﹂棬闆嗙編2 | 璁惧鍚嶇О |
+| machineTypeCd | String | 鏄� | 9999 | 琛ㄧず闂ㄧ |
+| machineTypeCdName | String | 鏄� | 闂ㄧ | 璁惧绫诲瀷璇存槑 |
+
+杩斿洖绀轰緥锛�
+```json
+{
+	"machines": [{
+		"direction": "3306",
+		"directionName": "杩涘満",
+		"heartbeatTime": "2020-12-31 18:06:40",
+		"locationObjId": "2020122471920846",
+		"locationObjName": "iot_灏忓尯 浣嶇疆3",
+		"machineCode": "1368371",
+		"machineId": "892020122872730977",
+		"machineIp": "",
+		"machineMac": "",
+		"machineName": "鍘﹂棬闆嗙編2",
+		"machineTypeCd": "9999",
+		"machineTypeCdName": "闂ㄧ"
+	}],
+	"page": 1,
+	"records": 1,
+	"rows": 1,
+	"total": 0
+}
+```
+
+## 鐗╀笟鏌ヨ鎵�鏈夎澶�
+
+璇存槑锛氭煡璇笟涓诲彲浠ュ紑闂ㄨ澶�
+
+璇锋眰鏂瑰紡锛� GET
+
+璇锋眰鍦板潃锛�/api/machine.listMachines
+
+璇锋眰鍙傛暟锛�
+
+| 鍚嶇О | 绫诲瀷 | 鏄惁蹇呭～ | 绀轰緥鍊� | 鎻忚堪 |
+| :----:| :----: | :----: | :----: | :----: |
+| page | Integer | 鏄� | 1 | 椤垫暟 |
+| row | Integer | 鏄� | 10 | 姣忛〉鏄剧ず鏁伴噺 |
+| communityId | String | 鏄� | 2020122471920846 | 灏忓尯ID |
+
+璇锋眰绀轰緥锛�
+```url
+
+http://ip:port/api/machine.listMachines?communityId=2020122471920846&page=1&row=10
+
+```
+
+杩斿洖鍙傛暟锛�
+
+| 鍚嶇О | 绫诲瀷 | 鏄惁蹇呭～ | 绀轰緥鍊� | 鎻忚堪 |
+| :----:| :----: | :----: | :----: | :----: |
+| direction | String | 鏄� | 3306 | 杩涘満 |
+| directionName | String | 鏄� | 杩涘満 | 涓枃鎻忚堪 |
+| heartbeatTime | String | 鏄� | 2020-12-31 18:06:40 | 璁惧鏈�杩戝績璺虫椂闂� |
+| locationObjId | String | 鏄� | 2020122471920846 | 浣嶇疆ID |
+| locationObjName | String | 鏄� | iot_灏忓尯 浣嶇疆3 | 浣嶇疆璇存槑 |
+| machineCode | String | 鏄� | 1368371 | 璁惧缂栫爜 |
+| machineId | String | 鏄� | 892020122872730977 | 璁惧ID |
+| machineIp | String | 鍚� | 192.168.1.1 | 璁惧IP |
+| machineMac | String | 鍚� | 11:11:11:11 | 璁惧mac |
+| machineName | String | 鏄� | 鍘﹂棬闆嗙編2 | 璁惧鍚嶇О |
+| machineTypeCd | String | 鏄� | 9999 | 琛ㄧず闂ㄧ |
+| machineTypeCdName | String | 鏄� | 闂ㄧ | 璁惧绫诲瀷璇存槑 |
+
+杩斿洖绀轰緥锛�
+```json
+{
+	"machines": [{
+		"direction": "3306",
+		"directionName": "杩涘満",
+		"heartbeatTime": "2020-12-31 18:06:40",
+		"locationObjId": "2020122471920846",
+		"locationObjName": "iot_灏忓尯 浣嶇疆3",
+		"machineCode": "1368371",
+		"machineId": "892020122872730977",
+		"machineIp": "",
+		"machineMac": "",
+		"machineName": "鍘﹂棬闆嗙編2",
+		"machineTypeCd": "9999",
+		"machineTypeCdName": "闂ㄧ"
+	}],
+	"page": 1,
+	"records": 1,
+	"rows": 1,
+	"total": 0
+}
+```
+
 ## 杩滅▼寮�闂�
+
+璇存槑锛氱墿涓氱郴缁焪eb绔紝涓氫富鎵嬫満绔垨鑰呯墿涓氭墜鏈虹増杩滅▼寮�闂ㄥ満鏅�
+
+璇锋眰鏂瑰紡锛� POST
+
+璇锋眰鍦板潃锛�/api/machine/openDoor
+
+璇锋眰鍙傛暟锛�
+
+| 鍚嶇О | 绫诲瀷 | 鏄惁蹇呭～ | 绀轰緥鍊� | 鎻忚堪 |
+| :----:| :----: | :----: | :----: | :----: |
+| machineCode | String | 鏄� | 1368371 | 璁惧缂栧彿 |
+| userRole | String | owner | 0 | 鐢ㄦ埛瑙掕壊锛宱wner 鏄笟涓伙紝staff 涓哄憳宸� |
+| userId | String | 鍚� | 123123 | 褰撶敤鎴疯鑹蹭负涓氫富鏃跺繀濉紝鍛樺伐鏃朵笉濉� |
+| communityId | String | 鏄� | 2020122471920846 | 灏忓尯ID |
+
+璇锋眰绀轰緥锛�
+```json
+{
+	"machineCode": "1368371",
+	"userRole": "owner",
+	"userId":"123123",
+	"communityId": "2020122471920846"
+}
+```
+
+杩斿洖绀轰緥锛�
+```json
+{
+    "code":0,
+    "msg":"鎴愬姛",
+    "data":""
+}
+```
 
 ## 璁惧閲嶅惎
 
+璇存槑锛氱墿涓氱郴缁焪eb绔� 閲嶅惎璁惧鍦烘櫙
+
+璇锋眰鏂瑰紡锛� POST
+
+璇锋眰鍦板潃锛�/api/machine/restartMachine
+
+璇锋眰鍙傛暟锛�
+
+| 鍚嶇О | 绫诲瀷 | 鏄惁蹇呭～ | 绀轰緥鍊� | 鎻忚堪 |
+| :----:| :----: | :----: | :----: | :----: |
+| machineCode | String | 鏄� | 1368371 | 璁惧缂栧彿 |
+| communityId | String | 鏄� | 2020122471920846 | 灏忓尯ID |
+
+璇锋眰绀轰緥锛�
+```json
+{
+	"machineCode": "1368371",
+	"communityId": "2020122471920846"
+}
+```
+
+杩斿洖绀轰緥锛�
+```json
+{
+    "code":0,
+    "msg":"鎴愬姛",
+    "data":""
+}
+```
+
 ## 浜鸿劯寮�闂ㄨ褰曚笂鎶�
+
+璇存槑锛欻C鐗╄仈缃戠郴缁熷皢寮�闂ㄨ褰曚笂鎶ョ墿涓氱郴缁�
+
+璇锋眰鏂瑰紡锛� POST
+
+璇锋眰鍦板潃锛�/api/machine/openDoorLog
+
+璇锋眰鍙傛暟锛�
+
+| 鍚嶇О | 绫诲瀷 | 鏄惁蹇呭～ | 绀轰緥鍊� | 鎻忚堪 |
+| :----:| :----: | :----: | :----: | :----: |
+| userId | String | 鏄� | 702020042194860037 | 鐢ㄦ埛ID |
+| userName | String | 鏄� | 寮犱笁 | 鐢ㄦ埛鍚嶇О |
+| machineCode | String | 鏄� | 101010 | 璁惧缂栫爜 |
+| openTypeCd | String | 鏄� | 1000 | 寮�闂ㄦ柟寮� 1000 浜鸿劯寮�闂� 2000 閽ュ寵寮�闂� |
+| similar | String | 鏄� | 100 | 寮�闂ㄧ浉浼煎害 |
+| photo | String | 鏄� | base64,xxx | 鎶撴媿鐓х墖 |
+| dateTime | String | 鏄� | 2020-12-27 00:00:00 | 寮�闂ㄦ椂闂� |
+| extCommunityId | String | 鏄� | 702020042194860039 | 灏忓尯ID |
+| recordTypeCd | String | 鏄� | 8888 | 璁板綍绫诲瀷锛�8888 寮�闂ㄨ褰� 6666 璁垮鐣欏奖 |
+
+
+璇锋眰绀轰緥锛�
+```json
+{
+    "userId": "702020042194860037",
+    "userName": "寮犱笁",
+    "machineCode": "101010",
+    "openTypeCd": "1000",
+    "similar": "100",
+    "photo": "base64,xxx",
+    "dateTime": "2020-12-27 00:00:00",
+    "extCommunityId": "702020042194860039",
+    "recordTypeCd": "8888"
+}
+```
+
+杩斿洖绀轰緥锛�
+```json
+{
+    "code":0,
+    "msg":"鎴愬姛",
+    "data":""
+}
+```
 
 ## 鐗╄仈缃戞寚浠ゆ墽琛岀粨鏋滃弽棣堬紙褰撳拰鐗╄仈缃戠郴缁熷紓姝ヤ氦浜掓椂鏈夋晥锛�
 
@@ -42,4 +280,5 @@
     "msg":"鎴愬姛",
     "data":""
 }
-```
\ No newline at end of file
+```
+

--
Gitblit v1.8.0