CSR配置字典之[类名称]类
更新时间：2025/07/12
在Gitcode上查看源码NOTE
该文档仍在建设中，敬请期待。
📋 文档信息
| 字段 | 值 |
|---|---|
| 文档标题 | CSR配置字典之[类名称]类 |
| 创建日期 | [YYYY-MM-DD] |
| 最后更新 | [YYYY-MM-DD] |
| 文档版本 | v[版本号] |
| 维护人员 | Hardware SIG |
| 审核状态 | ✅ 已审核 |
📋 变更历史
| 版本 | 日期 | 变更内容 | 变更人 | 审核人 | 备注 |
|---|---|---|---|---|---|
| v1.0 | [YYYY-MM-DD] | 初始版本创建 | 开发团队 | 技术负责人 | 首次发布 |
🎯 类概览
[类名称]类 是BMC固件中用于[功能描述]的配置类。该类提供了[主要功能1]、[主要功能2]和[主要功能3]等功能。 状态: 🟢 活跃维护中
适用范围: [适用范围描述]
依赖组件: [依赖组件1]、[依赖组件2]、[依赖组件3]
📊 属性定义详表
必选属性
| 属性名 | 类型 | 默认值 | 取值范围 | 动态关联 | 描述 | 使用场景 | 举例 | 来源 |
|---|---|---|---|---|---|---|---|---|
| UId | [硬件/软件] | [默认值] | [取值范围] | [动态关联对象] | 唯一标识符，格式：[具体格式说明] | 身份识别 | "[示例UID值]" | [CSR配置/硬件提供/软件生成] |
| Name | [硬件/软件] | [默认值] | [取值范围] | [动态关联对象] | 组件名称，[命名规则说明] | 接口展示 | "[示例名称]" | [CSR配置/硬件提供/软件生成] |
| Version | [硬件/软件] | [默认值] | [取值范围] | [动态关联对象] | 版本号 | 升级校验 | "#/Accessor_[组件名]Ver.Value" | [CSR配置/硬件提供/软件生成] |
| Location | [硬件/软件] | [默认值] | [取值范围] | [动态关联对象] | 器件位号 | 硬件定位 | [示例位号] | [CSR配置/硬件提供/软件生成] |
| Status | [硬件/软件] | [默认值] | [取值范围] | [动态关联对象] | 运行状态 | 状态监控 | "#/Accessor_[组件名]Status.Value" | [CSR配置/硬件提供/软件生成] |
可选属性
| 属性名 | 类型 | 默认值 | 取值范围 | 动态关联 | 描述 | 使用场景 | 举例 | 来源 |
|---|---|---|---|---|---|---|---|---|
| ExtendedInfo | [硬件/软件] | [默认值] | [取值范围] | [动态关联对象] | 扩展信息 | 调试诊断 | "[扩展信息示例]" | [CSR配置/硬件提供/软件生成] |
| TestMode | [硬件/软件] | 0 | 0或1 | [动态关联对象] | 测试模式开关 | 测试验证 | 0 | [CSR配置/硬件提供/软件生成] |
🔗 动态关联机制
[关联类型1]关联
json
{
"属性名": "#/目标对象.属性名"
}[关联类型2]关联
json
{
"属性名": "<=/表达式对象.Value"
}[关联类型3]关联
json
{
"属性名": "|> expr(表达式内容)"
}关联说明:
#/目标对象.属性名: [关联说明1]<=/表达式对象.Value: [关联说明2]|> expr(表达式内容): [关联说明3]
📂 分类标准
硬件属性
- 属性名1: [属性功能描述]
- 属性名2: [属性功能描述]
- 属性名3: [属性功能描述]
软件属性
- 属性名1: [属性功能描述]
- 属性名2: [属性功能描述]
- 属性名3: [属性功能描述]
📝 配置示例
基础配置
json
{
"[类名称]": {
"UId": "[示例UID值]",
"Name": "[示例名称]",
"Version": "#/Accessor_[组件名]Ver.Value",
"Location": [示例位号],
"Status": "#/Accessor_[组件名]Status.Value"
}
}高级配置
json
{
"[类名称]": {
"UId": "[示例UID值]",
"Name": "[示例名称]",
"Version": "#/Accessor_[组件名]Ver.Value",
"Location": [示例位号],
"Status": "#/Accessor_[组件名]Status.Value",
"ExtendedInfo": "[扩展信息示例]",
"TestMode": 0
}
}多实例配置
json
{
"[类名称]_1": {
"UId": "[示例UID值1]",
"Name": "[示例名称1]",
"Version": "#/Accessor_[组件名]Ver.Value",
"Location": [示例位号1],
"Status": "#/Accessor_[组件名]Status.Value"
},
"[类名称]_2": {
"UId": "[示例UID值2]",
"Name": "[示例名称2]",
"Version": "#/Accessor_[组件名]Ver.Value",
"Location": [示例位号2],
"Status": "#/Accessor_[组件名]Status.Value"
}
}复杂配置
json
{
"[类名称]": {
"UId": "[示例UID值]",
"Name": "[示例名称]",
"Version": "|> expr((($1 > 1) ? $1 : 1))",
"Location": [示例位号],
"Status": "<=/Scanner_PowerGd.Value",
"ExtendedInfo": "[扩展信息示例]",
"TestMode": 1
}
}🔧 使用指南
配置步骤
- [步骤1]: [步骤描述]
- [步骤2]: [步骤描述]
- [步骤3]: [步骤描述]
- [步骤4]: [步骤描述]
- [步骤5]: [步骤描述]
最佳实践
- [最佳实践1]
- [最佳实践2]
- [最佳实践3]
- [最佳实践4]
注意事项
- [注意事项1]
- [注意事项2]
- [注意事项3]
- [注意事项4]
故障排除
- [问题1]: [解决方案]
- [问题2]: [解决方案]
- [问题3]: [解决方案]
- [问题4]: [解决方案]