@@ -4,29 +4,27 @@ sidebar_position: 2
44
55# 添加设备
66
7- ## 权限说明
8-
97::: info
108🤖 权限：仅** 组织成员** 及以上权限可以添加设备
119:::
1210
1311当组织引入新设备，并期望在平台中创建一台与线下真实设备相对应的设备，可前往组织设备页面进行添加。
1412
15- ## 添加方式概述
16-
17- 平台提供以下 3 种添加新设备到组织的方式：
13+ 平台提供以下 3 种设备添加方式：
1814
1915| 添加方式 | 适用场景 |
2016| -------------------- | ------------------------------------------ |
21- | 在设备端执行命令添加 | 少量设备逐一准入与平台通信 |
22- | 使用离线安装包添加 | 设备出厂批量准入与平台通信 |
23- | 填写信息添加 | 快速创建仅用于数据流转的设备 ，不与平台通信 |
17+ | 在设备端执行命令添加 | 少量设备逐一安装
18+ | 使用离线安装包添加 | 设备出厂批量安装
19+ | 填写信息添加 | 快速创建仅用于数据管理的设备 ，不与平台通信 |
2420
2521## 在设备端执行命令添加 {#add-device-from-device}
2622
2723### 适用情况与入口
2824
29- 此方式适用于少量设备逐次接入平台。用户需手动通过 SSH 登录设备执行命令。入口位于「组织管理」页面的「设备」分页，点击【添加设备】按钮，进入添加设备弹窗
25+ 此方式适用于少量设备逐次接入平台。用户需在真实设备上打开终端，执行相应的注册命令。
26+
27+ 入口位于「组织管理」页面的「设备」分页，点击【添加设备】按钮，进入添加设备弹窗
3028
3129![ 添加设备入口] ( ./img/4-3-add-device-button.png )
3230
@@ -36,102 +34,119 @@ sidebar_position: 2
3634
37351 . 当前仅支持 Linux 设备，涵盖 arm64 和 x86_64 架构；
3836
39- 2 . 暂不支持 Windows 设备，如有 Windows 设备接入需求，请联系刻行团队 。
37+ 2 . 暂不支持 Windows 设备，如有 Windows 设备接入需求，请联系我们 。
4038
4139### 设备 ID 配置
4240
43- 1 . 可填写存放设备唯一标识码（如 ID 或 SN）的位置，支持 txt、json、yaml 文本文件类型。
44-
45- - 若为 txt 文件，系统读取整个文件内容。
46-
47- - 若为 json、yaml 文件，需在下方输入框填写 ID 号的变量值（如文件中含 ` id:123 ` ，则在此处填写 ` id ` ）。
48-
49- 2 . 组织管理员可在「组织设备 - 编辑数采规则」中预设 ID 统一存放地址配置，实现弹窗自动填充，且支持二次更改。
41+ 设备 ID 是设备在平台中的唯一标识，注册后不可修改。设备 ID 的生成方式如下：
42+ - 从设备端获取设备的唯一标识码（推荐使用设备 SN）
43+ - 由系统自动生成随机 ID
44+
45+ 1 . ** 从设备端获取 ID** ：从设备端指定文件中获取 ID，支持 txt、json、yaml 文本文件类型。
46+ - txt 文件
47+ - 系统会读取文件的全部内容作为设备 ID
48+ - 只需填写该文件在设备上的完整路径
49+ - json、yaml 文件
50+ - 系统会读取文件中指定的字段作为设备 ID
51+ - 除文件路径外，还需在下方输入框填写字段标识名。（如文件内容为 ` id:123 ` ，在此处填写 ` id ` ，则会将 ` 123 ` 作为设备 ID）。
52+ - ID 设置
53+ - 为提高效率，组织管理员可在「组织设备 - 设备配置」中设置统一的设备 ID 文件路径
54+ - 设置后，添加设备时将自动填充该路径，用户仍可根据实际情况修改。详见[ 设备配置] ( ./4-device-collector.md#存储设置mod )
5055
5156 ![ 从设备端获取 ID 位置] ( ./img/4-3-add-device-id-01.png )
5257
53- 1 . 若选择系统生成 ID，平台将生成默认 ID 号，安装后不可修改。
58+ 2 . ** 系统生成 ID** ：平台生成默认 ID 号
5459
5560 ![ 系统生成 ID] ( ./img/4-3-add-device-id-02.png )
5661
5762### 安装客户端选择
5863
59641 . ** 数据采集（coScout）客户端**
6065
61- 安装后设备可依据项目规则或采集任务采集数据，安装前需管理员配置数采监听目录等信息，详情参考编辑数采规则文档 。
66+ 安装后设备可依据项目规则或采集任务采集数据，使用前需配置数采监听目录等信息，详情参考 [ 设备配置文档 ] ( ./4-device-collector.md#存储设置mod ) 。
6267
63682 . ** 远程控制（coLink）客户端**
6469
65- 安装后可实现网页 SSH、结合 [ coBridge] ( https://github.com/coscene-io/coBridge ) 实时可视化设备，功能详情参阅远程控制设备 [ 文档 ] ( https://docs.coscene.cn/docs/ device/device -remote-control) ；
70+ 安装后可实现网页 SSH、结合 [ coBridge] ( https://github.com/coscene-io/coBridge ) 实时可视化设备，功能详情参阅 [ 远程连接设备文档 ] ( ./5- device-remote-control.md ) ；
6671
67723 . ** 初始化客户端配置**
6873
69- 若设备更换上位机或 ID 后需重新安装注册，勾选【初始化客户端配置】；仅升级客户端版本则取消勾选，更多使用方法参阅换机、升级、卸载流程指南
74+ - 设备重新安装时：
75+ - 更换上位机或修改设备 ID：请勾选【初始化客户端配置】
76+ - 仅升级客户端版本：无需勾选【初始化客户端配置】
77+ - 详细操作步骤请参阅[ 换机、升级、卸载流程指南] ( ./7-change-device-guide.md )
7078
7179 ![ 安装客户端选择] ( ./img/4-3-install-coscout-colink.png )
7280
7381### 执行安装命令
82+ > 注意：
83+ > 设备端执行命令添加时，若以 root 用户执行命令，或在命令前加 ` sudo ` ，会将 coScout 安装在 root 下；若直接使用当前用户执行命令，会将 coScout 安装在当前用户下。
7484
75851 . 完成设备 ID 及安装客户端选项配置后，系统生成安装命令。用户复制命令至设备端 shell 终端执行。
7686
7787 ![ 系统生成安装命令] ( ./img/4-3-install-cmd.png )
7888
79- 2 . 设备端出现 ` Installation completed successfully 🎉 ` 提示即安装成功。 受设备性能影响，安装完成后设备列表页显示可能存在延迟， 此时设备已完成注册，后续操作参考设备准入部分
89+ 2 . 设备端出现 ` Installation completed successfully 🎉 ` 提示即安装成功( 受设备性能影响，安装完成后设备列表页显示可能存在延迟)。 此时设备已完成注册，后续操作参考 [ 设备启用文档 ] ( ./3-manage-device.md#enable-device ) 。
8090
8191 ![ 设备端安装成功] ( ./img/4-3-install-successfully.png )
8292
83- ![ 管理员到平台中准入设备 ] ( ./img/4-3-access-device.png )
93+ ![ 管理员到平台中启用设备 ] ( ./img/4-3-access-device.png )
8494
8595## 使用离线安装包添加
8696
8797### 适用情况与相关设置
8898
89- 1 . 此方式是相当于把数据采集、远程控制的安装包打包到设备软件版本更新包里，并且在安装包启动脚本里可以预先写好要执行的脚本赋权命令和安装命令，适合大规模的准入，比如设备出厂设置就自带了这两个客户端；
99+ 1 . 使用离线安装包添加设备：将数据采集和远程控制功能相关的安装包集成到设备的软件更新包中：
100+ - 适用于设备出厂批量部署场景
101+ - 可实现设备开箱即用，无需单独安装客户端
90102
91- 2 . 此添加方式中的「设备系统」、「设备 ID 配置」、「安装客户端选择」与在设备端执行命令添加的方式相同，可参考对应部分教程。以下重点介绍安装方式区别
103+ 2 . 配置说明：
104+ - 基础配置项（设备系统、设备 ID 配置、安装客户端选择）与「在设备端执行命令添加」方式相同，请参考上述章节了解详情
105+ - 下文将重点说明离线安装包特有的安装步骤
92106
93107### 安装步骤
94108
95- 1 . 假设用户位于 ` /root ` 目录下（切换目录时需注意更改路径），下载安装脚本 ** coscene.sh** 、离线二进制文件压缩包 ** cos_binaries.tar.gz** 至设备端，存放位置分别为 ` /root/coscene.sh ` , ` /root/cos_binaries.tar.gz ` 。
109+ 1 . 下载安装脚本 ** install.sh** 、安装包 ** cos_binaries.tar.gz** ，将其存放于至设备端。
110+
96111 ![ 下载离线安装包] ( ./img/4-3-download-offline-package.png )
97112
98- 2 . 在 root 目录下 ，给安装脚本赋予执行权限：
113+ 2 . 打开设备终端，在对应目录下 ，给安装脚本赋予执行权限：
99114
100115 ``` plain text
101- chmod +x /root/coscene .sh
116+ chmod +x install .sh
102117```
103118
104- 3 . 执行安装命令（以 ` cos_binaries.tar.gz ` 位于 ` /root/cos_binaries.tar.gz ` 为例） ：
119+ 3 . 在设备终端， 执行安装命令：
105120
106121 ``` plain text
107- ./coscene .sh --server_url=*** --project_slug= *** --virmesh_endpoint= *** --use_local=/root/cos_binaries.tar.gz
122+ ./install .sh --use_local=./cos_binaries.tar.gz --mod="default" --org_slug="***" -- server_url=" ***" --coLink_endpoint=" ***" --coLink_network=" ***" --sn_file="***" --sn_field="***" --remove_config
108123```
109124
110- 其中，参数 ` --server_url ` ， ` --project_slug ` ， ` --virmesh_endpoint ` 请参考网页端添加设备弹窗中的安装命令生成结果替换 ` *** ` ，参数 ` -- use_local` 为离线二进制文件压缩包路径，修改目录位置时需同步修改该参数 。
125+ 其中，参数 ` --use_local ` 为离线安装包在设备上的路径，需根据实际情况进行修改 。
111126
112127 ![ 使用离线安装包添加] ( ./img/4-3-offline-install-package.png )
113128
114129## 填写信息添加
115130
116131### 适用情况
117132
118- 此方式平台数据库创建虚拟设备字段 ，不与真实设备对应。
133+ 创建虚拟设备字段，仅用于数据管理 ，不与真实设备对应。
119134
120135### 操作步骤
121136
1221371 . 在「添加设备」弹框输入设备 ID 及其他信息（设备 ID 不可重复），点击【添加】即可创建设备。
123138
124- 2 . 若组织管理员设置自定义字段，用户需按页面提示填写完整必填项 （如示例中的门店、机型）
139+ 2 . 若组织管理员设置了设备自定义字段，用户需按页面提示填写必填项 （如示例中的门店、机型）
125140
126- ![ 使用离线安装包添加 ] ( ./img/4-3-input-information.png )
141+ ![ 填写信息添加 ] ( ./img/4-3-input-information.png )
127142
128143## 后续操作
129- - [ 设备准入 ] ( ./3-manage-device.md#设备准入 )
130- - [ 将设备添加到项目] ( ./3-manage-device.md#分配设备到项目 )
131- - [ 手动采集数据] ( ../use-case/1-common-task.md )
132- - [ 根据错误码自动采集数据] ( ../use-case/data-diagnosis/2-get-started.md )
144+ - [ 启用设备 ] ( ./3-manage-device.md#enable-device )
145+ - [ 将设备添加到项目] ( ./3-manage-device.md#assign-devices-to-projects )
146+ - [ 手动采集数据] ( ../use-case/1-common-task.md )
147+ - [ 根据错误码自动采集数据] ( ../use-case/data-diagnosis/2-get-started.md )
133148- [ 远程连接设备] ( ./5-device-remote-control.md )
134- - 实时可视化
135- - 网页 SSH
136- - 远程下发命令
137- - 端口映射
149+ - 实时可视化
150+ - 网页 SSH
151+ - 远程下发命令
152+ - 端口映射
0 commit comments