更新 readme.md

This commit is contained in:
Marcin 2025-12-04 09:41:52 +08:00
parent 0bb410c72f
commit 2bc1bf05c6

@ -7,24 +7,25 @@
- [nicsensor工具使用说明](#nicsensor工具使用说明)
- [目录](#目录)
- [1\_简介](#1_简介)
- [2\_使用方法](#2_使用方法)
- [2\_1\_传感器读取](#2_1_传感器读取)
- [2\_2\_FRU相关操作](#2_2_fru相关操作)
- [2\_3\_命令透传](#2_3_命令透传)
- [2\_4\_插槽I2C信息遍历](#2_4_插槽i2c信息遍历)
- [2\_5\_调试模式使用](#2_5_调试模式使用)
- [2\_6\_扩展功能](#2_6_扩展功能)
- [2\_7\_设定配置功能](#2_7_设定配置功能)
- [3\_常见问题](#3_常见问题)
- [3\_1\_ADC128传感器读值为0](#3_1_adc128传感器读值为0)
- [3\_2\_脚本执行时出现大批量语法错误](#3_2_脚本执行时出现大批量语法错误)
- [4\_附属工具](#4_附属工具)
- [4\_1\_FruParse](#4_1_fruparse)
- [4\_2\_nicsensor\_s](#4_2_nicsensor_s)
- [5\_关于nicsensor\_v2](#5_关于nicsensor_v2)
- [6\_附录](#6_附录)
- [6\_1\_Project变量说明](#6_1_project变量说明)
- [1.简介](#1_简介)
- [2.使用方法](#2_使用方法)
- [2.1 传感器读取](#2_1_传感器读取)
- [2.2 FRU相关操作](#2_2_fru相关操作)
- [2.3 命令透传](#2_3_命令透传)
- [2.4 插槽I2C信息遍历](#2_4_插槽i2c信息遍历)
- [2.5 调试模式使用](#2_5_调试模式使用)
- [2.6 扩展功能](#2_6_扩展功能)
- [2.7 设定配置功能](#2_7_设定配置功能)
- [3.常见问题](#3_常见问题)
- [3.1 ADC128传感器读值为0](#3_1_adc128传感器读值为0)
- [3.2 脚本执行时出现大批量语法错误](#3_2_脚本执行时出现大批量语法错误)
- [3.3 传感器读值不正确](#3_3_传感器读值不正确)
- [4.附属工具](#4_附属工具)
- [4.1 FruParse](#4_1_fruparse)
- [4.2 nicsensor\_s](#4_2_nicsensor_s)
- [5.关于nicsensor\_v2](#5_关于nicsensor_v2)
- [6.附录](#6_附录)
- [6.1 Project变量说明](#6_1_project变量说明)
## 1_简介
@ -67,6 +68,10 @@ nicsensor工具是在带有i2ctool工具(i2ctransfer、i2cdetect)的BMC下用于
``` shell
# 读取pcie2槽位上的adc128的信息, adc128芯片的地址为0x1f(7bit)
./nicsensor.sh pcie2 adc128 0x1f
# 读取pcie3槽位上的ina3221的信息, ina3221芯片的地址为0x40(7bit)
./nicsensor.sh 3 ina3221 0x40
# 读取ocp0槽位上的tmp112的信息, tmp112芯片的地址为0x48(7bit)
./nicsensor.sh ocp0 tmp112 0x48
```
### 2_2_FRU相关操作
@ -148,12 +153,7 @@ nicsensor工具是在带有i2ctool工具(i2ctransfer、i2cdetect)的BMC下用于
### 2_7_设定配置功能
> [!warning]
> 版本要求:
> - 测试版本 1.7.7 以上
> - 正式版本 1.8 及以上
可以通过一组名为 `get/set` 的指令对脚本中的如下变量做即时修改而无需修改脚本本体。支持修改的变量如下:
可以通过一组名为 `get/set` 的指令对脚本中的如下变量做即时修改而无需修改脚本(下电后恢复默认)。支持修改的变量如下:
- `server_type` : 对应属性值缩写 `server`
- `DEBUG_MODE` : 对应属性值缩写 `debug`
- `DISABLE_DETECT` : 对应属性值缩写 `detect`
@ -178,7 +178,11 @@ ADC128传感器在使用时需要初始化, 因此第一次读取时传感器可
### 3_2_脚本执行时出现大批量语法错误
通常是因为服务器上含有PCA9641切断了BMC的I2C控制权导致重试即可
通常是因为服务器上含有PCA9641切断了BMC的I2C控制权导致, 重试即可
### 3_3_传感器读值不正确
常见于ina3221传感器读值明显不正确, 因为ina3221的i2c slave地址比较敏感, 容易和pca9641产生冲突, 可首先按照i2c地址冲突的方向去排查问题。
## 4_附属工具
@ -186,12 +190,16 @@ ADC128传感器在使用时需要初始化, 因此第一次读取时传感器可
提供了一个简单python脚本用于解析FRU的数据, 将nicsensor读取到的FRU数据拷贝到frudata.txt后, 执行
`python fru_parse.py`即可将读取到的数据转化为FRU内容
**工具路径**:[fru_parse.py](./tool/fru_parse/fru_parse.py)
### 4_2_nicsensor_s
基于脚本版本1.8, 剔除了所有记日志的操作用于加速i2c的执行, 确保在9641工作的生命周期内尽快完成i2c任务
基于脚本版本1.8, 剔除了所有记日志的操作, 用于加速i2c的执行, 确保在9641工作的生命周期内尽快完成i2c任务
**工具路径**:[nicsensor_s.sh](./nicsensor_s.sh)
## 5_关于nicsensor_v2
nicsensor_v2将服务器选通channel和读取传感器数值的功能解耦因此在单独使用某个功能时可以直接找到对应的脚本进行测试。
nicsensor_v2将服务器选通channel和读取传感器数值的功能解耦, 因此在单独使用某个功能时可以直接找到对应的脚本进行测试。
详见[nicsensor_v2](./nicsensor_v2/readme.md)
## 6_附录