更新 nicsensor_v2/readme.md

This commit is contained in:
Marcin 2025-03-13 23:34:48 +08:00
parent ec9473b347
commit 0d3111a190

@ -1,21 +1,31 @@
# nicsensor tool V2 使用说明 # nicsensor tool V2 使用说明
## 1 简介 ## 目录
- [1 简介](#1_简介)
- [2 使用方法](#2_使用方法)
- [2.1 标准执行](#2_1_标准执行)
- [2.2 i2c扫描](#2_2_I2cScan)
- [2.3 传感器单独调试](#2_3_传感器单独调试)
- [3 代码结构](#3_代码结构)
- [3.1 脚本结构](#3_1_脚本结构)
- [3.2 执行顺序](#3_2_执行顺序)
## 1_简介
相比于`v1.x`版本的主要差异点: 相比于`v1.x`版本的主要差异点:
- 脚本模块化, 易于阅读和扩展 - 脚本模块化, 易于阅读和扩展
- 支持单独测试传感器数据 - 支持单独测试传感器数据
- 可扩展在多个平台的服务器使用 - 可扩展在多个平台的服务器使用
## 2 使用方法 ## 2_使用方法
### 2.1 标准执行 ### 2_1_标准执行
> **标准执行前**需要修改`nicsensor.sh` , 以及部分对应的 `plugin_xxx.sh` > **标准执行前**需要修改`nicsensor.sh` , 以及部分对应的 `plugin_xxx.sh`
> >
>>对于 `nicsensor.sh`, 使用前需要先修改脚本中的如下变量: >>对于 `nicsensor.sh`, 使用前需要先修改脚本中的如下变量:
>> `server_type`: 要应用的服务器类型 >> - `server_type`: 要应用的服务器类型
>> `server_platform`: 要应用服务器平台名称 >> - `server_platform`: 要应用服务器平台名称
> >
>> 对于 `plugin_xxx.sh`, 使用前需要针对具体的sensor指定对应的特殊变量 >> 对于 `plugin_xxx.sh`, 使用前需要针对具体的sensor指定对应的特殊变量
@ -34,7 +44,7 @@
./nicsensor.sh pcie2 adc128 0x1f ./nicsensor.sh pcie2 adc128 0x1f
``` ```
### 2.2 I2C Scan ### 2_2_I2cScan
类似于标准执行, 使用前需要现先在 `nicsensor.sh` 脚本中指定使用的服务器类型 类似于标准执行, 使用前需要现先在 `nicsensor.sh` 脚本中指定使用的服务器类型
@ -52,7 +62,7 @@
./nicsensor.sh detect pcie ./nicsensor.sh detect pcie
``` ```
### 2.3 传感器单独调试 ### 2_3_传感器单独调试
nicsensor v2 提供了针对每类传感器将十六进制读值直接可视化的功能用于单独调试 nicsensor v2 提供了针对每类传感器将十六进制读值直接可视化的功能用于单独调试
@ -74,9 +84,9 @@ nicsensor v2 提供了针对每类传感器将十六进制读值直接可视化
./plugin_tmp112.sh test 0x24 0x00 ./plugin_tmp112.sh test 0x24 0x00
``` ```
## 3 代码结构 ## 3_代码结构
### 3.1 脚本结构 ### 3_1_脚本结构
- 主控脚本 - 主控脚本
- [nicsensor](./nicsensor.sh): 标准执行的入口脚本 - [nicsensor](./nicsensor.sh): 标准执行的入口脚本
@ -96,7 +106,7 @@ nicsensor v2 提供了针对每类传感器将十六进制读值直接可视化
- [format_print](./format_print.sh): 用于生成格式化console打印或者记录日志 - [format_print](./format_print.sh): 用于生成格式化console打印或者记录日志
- [auto_auth](./autoauth.sh): 用于一键执行为每个脚本文件赋予可执行权限 - [auto_auth](./autoauth.sh): 用于一键执行为每个脚本文件赋予可执行权限
### 3.2 执行顺序 ### 3_2_执行顺序
``` txt ``` txt
nicsensor.sh nicsensor.sh
| |