更新文档

ibuilding-X · Jun 6, 2024 · 1498196 · 1498196
1 parent b727980
commit 1498196
Showing 1 changed file with 21 additions and 20 deletions.
diff --git a/pages/src/content/docs/guides/config.mdx b/pages/src/content/docs/guides/config.mdx
@@ -34,14 +34,14 @@ config.json 是 driver-box 用于实现设备接入的描述文件。通常情
 
 
 <Tabs>
-    <TabItem label="config.json" icon="seti:csv">
+    <TabItem label="config.json" icon="seti:favicon">
         | 参数名                                | 类型     | 必填 | 说明                                                               |
         |:-----------------------------------|--------|:---|:-----------------------------------------------------------------|
         | deviceModels                        | array  | 必填 | 物模型配置。用于定义特定通讯协议类型`protocolName`的物模型及其接入设备列表                     |
         | connections                         | object | 必填 | 连接配置，不同类型的插件配置各不相同                                               |
         | protocolName                        | string | 必填 | 协议插件名称，有效范围：<ul><li>[modbus](/driver-box/plugins/modbus/)</li><li>bacnet</li><li>mqtt</li><li>[mirror](/driver-box/export/mirror/)</li></ul> |
     </TabItem>
-    <TabItem label="deviceModels" icon="seti:csv">
+    <TabItem label="deviceModels">
         | 参数名                                | 类型     | 必填 | 说明               |
         |:-----------------------------------|--------|:---|:-----------------|
         | name                               | string | 必填 | 设备模型名称，又可称为物模型名称 |
@@ -50,7 +50,7 @@ config.json 是 driver-box 用于实现设备接入的描述文件。通常情
         | devicePoints | array | 必填 | 设备点表配置           |
         | devices         | array | 必填 | 设备列表             |
     </TabItem>
-    <TabItem label="devicePoints" icon="seti:csv">
+    <TabItem label="devicePoints">
         | 参数名         | 类型     | 必填 | 说明                                                                                                                                                                                   |
         |:------------|--------|:---|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
         | name        | string | 必填 | 点位名                                                                                                                                                                                  |
@@ -64,32 +64,33 @@ config.json 是 driver-box 用于实现设备接入的描述文件。通常情
         |-|-| 可选 | 插件扩展点表配置。不同类型的插件会在上述配置的基础上额外添加新的配置项。例如：Modbus插件在配置中添加了`slaveId`、`timeout`等配置项。<br/><ul><li>[modbus](#modbus连接配置)</li><li>[bacnet](#bacnet连接配置)</li></ul>                             |
 
     </TabItem>
-    <TabItem label="devices" icon="seti:csv">
+    <TabItem label="devices">
         | 参数名         | 类型     | 必填 | 说明                                                                                                  |
         |-------------|----|----|-----------------------------------------------------------------------------------------------------|
         | sn          |string| 必填 | 设备序列号                                                                                               |
         | description |string| 选填 | 设备描述                                                                                                |
         | ttl         |string| 选填 | 设备离线阈值，超过该时长没有收到数据视为离线。<br/>示例：<ul><li>`1m`: 1分钟</li><li>`1h`: 1小时</li><li>`1d`: 1天</li></ul>默认：24h |
         |connectionKey|string| 必填 | 设备连接标识                                                                                              |
         |properties|object| 选填 | 设备属性。通常用于配置设备的保留属性或连接相关信息。                                                                          |
-    </TabItem>
-</Tabs>
 
+        **保留属性**
 
-**保留属性**
+        保留属性是 driver-box 为设备提供的扩展信息配置能力。这类属性的业务逻辑交由用户实现，driver-box 只作配置的持久化。
 
-保留属性是 driver-box 为设备提供的扩展信息配置能力。这类属性的业务逻辑交由用户实现，driver-box 只作配置的持久化。
+        目前开放的保留属性如下：
+        - _area：设备所处的区域信息
+        - _parent_sn：父级设备 SN
+        - _system_id：设备所属的系统 ID
+    </TabItem>
+    <TabItem label="connections">
+        - [modbus](/driver-box/plugins/modbus/#modbus连接配置)
+        - bacnet
+        - mqtt
+        - http server
+        - http client
+        - tcp server
+        - tcp client
 
-目前开放的保留属性如下：
-- _area：设备所处的区域信息
-- _parent_sn：父级设备 SN
-- _system_id：设备所属的系统 ID
+    </TabItem>
+</Tabs>
 
-### 连接配置
-- [modbus](/driver-box/plugins/modbus/#modbus连接配置)
-- bacnet
-- mqtt
-- http server
-- http client
-- tcp server
-- tcp client