From d5f4a6f0d8d8fbcc0358385082f8fa5a90b6caa2 Mon Sep 17 00:00:00 2001 From: leimingsheng Date: Tue, 13 May 2025 10:20:05 +0800 Subject: [PATCH] =?UTF-8?q?doc(master=20:=20readme)=E6=B7=BB=E5=8A=A0Proje?= =?UTF-8?q?ct=20Varible=E7=9A=84=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- readme.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 61 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 6f75526..a185800 100644 --- a/readme.md +++ b/readme.md @@ -20,6 +20,8 @@ - [4\_附属工具](#4_附属工具) - [4\_1\_FruParse](#4_1_fruparse) - [5\_关于nicsensor\_v2](#5_关于nicsensor_v2) + - [6\_附录](#6_附录) + - [6\_1\_Project变量说明](#6_1_project变量说明) ## 1_简介 @@ -45,7 +47,7 @@ nicsensor工具是在带有i2ctool工具(i2ctransfer、i2cdetect)的BMC下用于 ## 2_使用方法 > [!warning] -> 在使用时针对网卡的硬件特性需要定制化修改脚本的 `Project Varible` +> 在使用时针对网卡的硬件特性需要定制化修改脚本的 `Project Varible` ,变量的对应关系及说明见[Project变量说明](#6_1_project变量说明) ### 2_1_传感器读取 @@ -160,4 +162,61 @@ ADC128传感器在使用时需要初始化, 因此第一次读取时传感器可 ## 5_关于nicsensor_v2 nicsensor_v2将服务器选通channel和读取传感器数值的功能解耦，因此在单独使用某个功能时可以直接找到对应的脚本进行测试。 -详见[nicsensor_v2](./nicsensor_v2/readme.md) \ No newline at end of file +详见[nicsensor_v2](./nicsensor_v2/readme.md) + +## 6_附录 + +### 6_1_Project变量说明 + +**ADC128**相关 +- `votage_division_factor_0`: ADC128芯片Channel 0的分压系数 +- `votage_division_factor_1`: ADC128芯片Channel 1的分压系数 +- `votage_division_factor_2`: ADC128芯片Channel 2的分压系数 +- `votage_division_factor_3`: ADC128芯片Channel 3的分压系数 +- `votage_division_factor_4`: ADC128芯片Channel 4的分压系数 +- `votage_division_factor_5`: ADC128芯片Channel 5的分压系数 +- `votage_division_factor_6`: ADC128芯片Channel 6的分压系数 +- `votage_division_factor_7`: ADC128芯片Channel 7的分压系数 + +- `ADC128_Channel0_name`: 定制化ADC128芯片Channel 0的电压名称 +- `ADC128_Channel1_name`: 定制化ADC128芯片Channel 1的电压名称 +- `ADC128_Channel2_name`: 定制化ADC128芯片Channel 2的电压名称 +- `ADC128_Channel3_name`: 定制化ADC128芯片Channel 3的电压名称 +- `ADC128_Channel4_name`: 定制化ADC128芯片Channel 4的电压名称 +- `ADC128_Channel5_name`: 定制化ADC128芯片Channel 5的电压名称 +- `ADC128_Channel6_name`: 定制化ADC128芯片Channel 6的电压名称 +- `ADC128_Channel7_name`: 定制化ADC128芯片Channel 7的电压名称 + +**INA3221**相关 +- `shunt_resistor_0`: INA3221芯片的Channel 0外接的分流电阻的大小(单位:毫欧) +- `shunt_resistor_1`: INA3221芯片的Channel 1外接的分流电阻的大小(单位:毫欧) +- `shunt_resistor_2`: INA3221芯片的Channel 2外接的分流电阻的大小(单位:毫欧) + +- `INA3221_Channel0_name`: 定制化INA3221芯片Channel 0的名称 +- `INA3221_Channel1_name`: 定制化INA3221芯片Channel 1的名称 +- `INA3221_Channel2_name`: 定制化INA3221芯片Channel 2的名称 + +**EMC1413**相关 +- `EMC1413_Channel0_name`: 定制化EMC1413芯片Channel 0的温度名称 +- `EMC1413_Channel1_name`: 定制化EMC1413芯片Channel 1的温度名称 +- `EMC1413_Channel2_name`: 定制化EMC1413芯片Channel 2的温度名称 + +**TMP468**相关 +- `TMP468_Channel0_name`: 定制化TMP468芯片Loacl Channel的温度名称 +- `TMP468_Channel1_name`: 定制化TMP468芯片Remote1 Channel的温度名称 +- `TMP468_Channel2_name`: 定制化TMP468芯片Remote2 Channel的温度名称 +- `TMP468_Channel3_name`: 定制化TMP468芯片Remote3 Channel的温度名称 +- `TMP468_Channel4_name`: 定制化TMP468芯片Remote4 Channel的温度名称 +- `TMP468_Channel5_name`: 定制化TMP468芯片Remote5 Channel的温度名称 +- `TMP468_Channel6_name`: 定制化TMP468芯片Remote6 Channel的温度名称 +- `TMP468_Channel7_name`: 定制化TMP468芯片Remote7 Channel的温度名称 +- `TMP468_Channel8_name`: 定制化TMP468芯片Remote8 Channel的温度名称 + +**TMP112**相关 +- `TMP112_Sensor_name`: 定制化TMP112对应的名称 + +**FRU**相关 +- `fru_offset`: 网卡FRU所在eeprom的偏移量。默认值为 0x00 0x00 + +**所用服务器** +- `server_type`: 脚本将工作在哪个服务器上?支持的服务器列表见`Support_Server_List` \ No newline at end of file