AI-on-the-edge-device 配置参数全览从 config.ini 到参数文档体系的完整指南【免费下载链接】AI-on-the-edge-deviceEasy to use device for connecting old measuring units (water, power, gas, ...) to the digital world项目地址: https://gitcode.com/GitHub_Trending/ai/AI-on-the-edge-device导读本文以 param-docs/templates/overview.md 为核心骨架系统讲解 AI-on-the-edge-device 的配置参数总览体系如何读懂 SD 卡上的 config.ini 配置文件、参数如何按区段Section组织、复选框禁用机制的工作原理以及仓库中围绕参数建立的自动文档生成体系parameter-pages、模板生成器、Expert 参数与隐藏参数标记。读完本文你将掌握该项目的参数管理全貌知道每个参数去哪里查、如何安全修改、以及 Web 界面 Tooltip 提示的来源。一、参数总览页在文档体系中的定位overview.md是项目参数文档体系的目录页其核心作用有三汇总入口列出所有可用配置Configuration参数是查找任意参数的起点声明交互语义明确指出如果某个参数或区段左侧有复选框tick box你可以在 Web 配置界面中禁用它——禁用后该功能被关闭或使用默认值标注生成机制页面标注为自动生成auto-generated其数据来源与生成规则由 param-docs/README.md 说明。这意味着参数文档不是手写的静态页面而是由构建流程从真实配置文件驱动生成的。理解这一点是正确使用该文档体系的前提。二、参数的真实载体config.ini所有参数的实际载体是 SD 卡上的 sd-card/config/config.ini。该文件采用 INI 格式以[Section]分节节名即参数文档目录中的分组名。仓库当前默认配置包含以下区段区段职责代表参数[TakeImage]拍照与摄像头传感器控制CamQuality、CamBrightness、CamAec、LEDIntensity、Demo[Alignment]参考图对齐InitialRotate、SearchFieldX/Y、AlignmentAlgo[Digits]数字数显读数识别Model、CNNGoodThreshold、ROI 行[Analog]指针式表盘读数识别Model、CNNGoodThreshold、ROI 行[PostProcessing]读数后处理与速率校验main.DecimalShift、main.ChangeRateThreshold、PreValueUse[MQTT]/[InfluxDB]/[InfluxDBv2]/[Webhook]数据上报通道Uri、MainTopic、Bucket、ApiKey等[GPIO]外部 GPIO 与 LEDIO0..IO13、LEDType、LEDColor[AutoTimer]自动定时读取Interval[DataLogging]/[Debug]数据与日志留存DataLogActive、LogLevel[System]系统级行为TimeZone、CPUFrequency、SetupMode、RSSIThreshold每个区段在 param-docs/parameter-pages/ 下都有同名子目录目录内为每个参数独立成页的 Markdown 文档。三、复选框禁用机制的实现语义overview.md中关于复选框的说明需要结合配置与源码理解其真实语义区段级复选框对应config.ini中以;注释掉的整个区段。例如 config.ini 中[MQTT]、[InfluxDB]、[InfluxDBv2]、[Webhook]默认整段被注释默认未启用在 Web 界面上即表现为未勾选状态参数级复选框对应单个参数行。禁用后该功能关闭或回退到默认值带main.前缀的参数表示该参数属于每个仪表NUMBER可独立配置的批量参数。在文档与界面中main.会被规范化为NUMBER.例如main.ChangeRateThreshold对应文档页 PostProcessing/NUMBER.ChangeRateThreshold.md。这一勾选即生效、取消即默认的设计让多表计multi-meter场景下既能统一配置又能按单个表计精细化覆盖。四、参数文档的自动生成体系4.1 三份驱动文件参数文档不是手工维护清单而是由脚本驱动生成共涉及四份关键文件模板文件param-docs/templates/parameter.md单个参数的文档骨架含$NAME参数名、$DEFAULT默认值占位符以及$EXPERT_PARAMETER、$HIDDEN_IN_UI两个条件标记总览模板param-docs/templates/overview.md 与 param-docs/templates/overview-old.md其中overview-old.md额外包含$TOC占位符用于生成全部参数的目录树Expert 参数清单param-docs/expert-params.txt列入该清单的参数如CamQuality、CamAec、SearchFieldX、CNNGoodThreshold等会在文档页中注入Expert Warning提示UI 隐藏参数清单param-docs/hidden-in-ui.txt列入该清单的参数如InitialRotate、MainTopicMQTT、SetupMode会在文档页中注入此参数无法通过 Web 配置界面访问的提示。4.2 生成脚本的工作原理生成器为 param-docs/generate-template-param-doc-pages.py其执行逻辑清晰从 rolling 分支拉取默认 config.ini逐行读取并剥离;注释还原出全部参数键值遍历每个区段跳过DEFAULT按区段在parameter-pages/下建立子目录遍历区段内每个参数跳过含空格的特殊格式行将main.前缀替换为NUMBER.生成Section/Parameter.md路径若该参数的文档页尚不存在则以 templates/parameter.md 为模板生成新页填入参数名与默认值已存在的页面不会被覆盖保证人工撰写的说明不被构建流程破坏若参数在 expert-params.txt 中注入 4 空格缩进的!!! WarningExpert 提示若在 hidden-in-ui.txt 中注入!!! NoteUI 隐藏提示。该脚本在生产流程中的双重用途param-docs/README.mdWeb 界面 TooltipGitHub Actions 构建时用这些参数页生成配置界面上的参数悬浮提示在线文档同一批页面用于生成在线参数文档站。因此新增参数必须同步补充描述页是该项目文档维护的硬性约定。五、典型参数文档的阅读方法以 TakeImage/CamQuality.md 为例一份合格参数页应包含参数名与默认值CamQuality默认10取值范围8最高质量63最低质量类似图片编辑软件导出 JPEG 时的质量滑块Expert 警告修改后必须重新更新参考图reference image与对齐标记低于10可能导致系统不稳定配套资料OV2640 / OV5640 传感器数据手册引用联动注意摄像头类参数修改会直接影响后续 Alignment 与 ROI 标注故被列为 Expert 参数。同样System/SetupMode.md 则展示了另一类特征它是隐藏参数不在 Web 配置界面暴露置为true后设备下次启动仍停留在 Setup 模式——这类参数只能通过直接编辑config.ini修改。六、实战建议如何安全地修改参数结合overview.md的语义与源码证据给出可落地的操作准则先查文档再动手任何参数修改前先到 param-docs/parameter-pages/ 对应区段目录下查阅该参数页确认取值范围、默认值与 Expert 警告区分三类参数普通参数可界面配置、Expert 参数需理解原理、常伴随联动影响、UI 隐藏参数仅能直改 config.ini善用复选框语义在 Web 配置界面取消勾选某区段/参数等价于关闭该功能或回退默认值无需删除配置行留意NUMBER.前缀参数如NUMBER.ChangeRateThreshold、NUMBER.MaxRateType对应默认配置中的main.ChangeRateThreshold 2、main.MaxRateValue 0.05修改前需确认是全局统一还是按表计覆盖修改传感器/图像类参数后如CamQuality等会影响图像输出务必按警告重新执行参考图与对齐标记的更新流程遵循新增即补文档约定若在配置中新增参数应同步在parameter-pages下建立描述页并运行生成脚本补全模板保证 Tooltip 与在线文档不缺失。七、总结overview.md虽然只是简短的一页但它锚定了 AI-on-the-edge-device 整个参数体系的三个关键事实参数以 config.ini 为唯一事实源、参数/区段的复选框决定启用状态与默认值回退、参数文档由模板脚本自动生成并与 Web 界面 Tooltip 联动。以它为入口配合 sd-card/config/config.ini、param-docs/parameter-pages/ 与 generate-template-param-doc-pages.py开发者可以快速定位、理解并安全地配置这个老旧表计数字化项目中从摄像头、识别模型到数据上报的全部参数。【免费下载链接】AI-on-the-edge-deviceEasy to use device for connecting old measuring units (water, power, gas, ...) to the digital world项目地址: https://gitcode.com/GitHub_Trending/ai/AI-on-the-edge-device创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 AI-on-the-edge-device 配置参数全览：从 config.ini 到参数文档体系的完整指南
AI-on-the-edge-device 配置参数全览从 config.ini 到参数文档体系的完整指南【免费下载链接】AI-on-the-edge-deviceEasy to use device for connecting old measuring units (water, power, gas, ...) to the digital world项目地址: https://gitcode.com/GitHub_Trending/ai/AI-on-the-edge-device导读本文以 param-docs/templates/overview.md 为核心骨架系统讲解 AI-on-the-edge-device 的配置参数总览体系如何读懂 SD 卡上的 config.ini 配置文件、参数如何按区段Section组织、复选框禁用机制的工作原理以及仓库中围绕参数建立的自动文档生成体系parameter-pages、模板生成器、Expert 参数与隐藏参数标记。读完本文你将掌握该项目的参数管理全貌知道每个参数去哪里查、如何安全修改、以及 Web 界面 Tooltip 提示的来源。一、参数总览页在文档体系中的定位overview.md是项目参数文档体系的目录页其核心作用有三汇总入口列出所有可用配置Configuration参数是查找任意参数的起点声明交互语义明确指出如果某个参数或区段左侧有复选框tick box你可以在 Web 配置界面中禁用它——禁用后该功能被关闭或使用默认值标注生成机制页面标注为自动生成auto-generated其数据来源与生成规则由 param-docs/README.md 说明。这意味着参数文档不是手写的静态页面而是由构建流程从真实配置文件驱动生成的。理解这一点是正确使用该文档体系的前提。二、参数的真实载体config.ini所有参数的实际载体是 SD 卡上的 sd-card/config/config.ini。该文件采用 INI 格式以[Section]分节节名即参数文档目录中的分组名。仓库当前默认配置包含以下区段区段职责代表参数[TakeImage]拍照与摄像头传感器控制CamQuality、CamBrightness、CamAec、LEDIntensity、Demo[Alignment]参考图对齐InitialRotate、SearchFieldX/Y、AlignmentAlgo[Digits]数字数显读数识别Model、CNNGoodThreshold、ROI 行[Analog]指针式表盘读数识别Model、CNNGoodThreshold、ROI 行[PostProcessing]读数后处理与速率校验main.DecimalShift、main.ChangeRateThreshold、PreValueUse[MQTT]/[InfluxDB]/[InfluxDBv2]/[Webhook]数据上报通道Uri、MainTopic、Bucket、ApiKey等[GPIO]外部 GPIO 与 LEDIO0..IO13、LEDType、LEDColor[AutoTimer]自动定时读取Interval[DataLogging]/[Debug]数据与日志留存DataLogActive、LogLevel[System]系统级行为TimeZone、CPUFrequency、SetupMode、RSSIThreshold每个区段在 param-docs/parameter-pages/ 下都有同名子目录目录内为每个参数独立成页的 Markdown 文档。三、复选框禁用机制的实现语义overview.md中关于复选框的说明需要结合配置与源码理解其真实语义区段级复选框对应config.ini中以;注释掉的整个区段。例如 config.ini 中[MQTT]、[InfluxDB]、[InfluxDBv2]、[Webhook]默认整段被注释默认未启用在 Web 界面上即表现为未勾选状态参数级复选框对应单个参数行。禁用后该功能关闭或回退到默认值带main.前缀的参数表示该参数属于每个仪表NUMBER可独立配置的批量参数。在文档与界面中main.会被规范化为NUMBER.例如main.ChangeRateThreshold对应文档页 PostProcessing/NUMBER.ChangeRateThreshold.md。这一勾选即生效、取消即默认的设计让多表计multi-meter场景下既能统一配置又能按单个表计精细化覆盖。四、参数文档的自动生成体系4.1 三份驱动文件参数文档不是手工维护清单而是由脚本驱动生成共涉及四份关键文件模板文件param-docs/templates/parameter.md单个参数的文档骨架含$NAME参数名、$DEFAULT默认值占位符以及$EXPERT_PARAMETER、$HIDDEN_IN_UI两个条件标记总览模板param-docs/templates/overview.md 与 param-docs/templates/overview-old.md其中overview-old.md额外包含$TOC占位符用于生成全部参数的目录树Expert 参数清单param-docs/expert-params.txt列入该清单的参数如CamQuality、CamAec、SearchFieldX、CNNGoodThreshold等会在文档页中注入Expert Warning提示UI 隐藏参数清单param-docs/hidden-in-ui.txt列入该清单的参数如InitialRotate、MainTopicMQTT、SetupMode会在文档页中注入此参数无法通过 Web 配置界面访问的提示。4.2 生成脚本的工作原理生成器为 param-docs/generate-template-param-doc-pages.py其执行逻辑清晰从 rolling 分支拉取默认 config.ini逐行读取并剥离;注释还原出全部参数键值遍历每个区段跳过DEFAULT按区段在parameter-pages/下建立子目录遍历区段内每个参数跳过含空格的特殊格式行将main.前缀替换为NUMBER.生成Section/Parameter.md路径若该参数的文档页尚不存在则以 templates/parameter.md 为模板生成新页填入参数名与默认值已存在的页面不会被覆盖保证人工撰写的说明不被构建流程破坏若参数在 expert-params.txt 中注入 4 空格缩进的!!! WarningExpert 提示若在 hidden-in-ui.txt 中注入!!! NoteUI 隐藏提示。该脚本在生产流程中的双重用途param-docs/README.mdWeb 界面 TooltipGitHub Actions 构建时用这些参数页生成配置界面上的参数悬浮提示在线文档同一批页面用于生成在线参数文档站。因此新增参数必须同步补充描述页是该项目文档维护的硬性约定。五、典型参数文档的阅读方法以 TakeImage/CamQuality.md 为例一份合格参数页应包含参数名与默认值CamQuality默认10取值范围8最高质量63最低质量类似图片编辑软件导出 JPEG 时的质量滑块Expert 警告修改后必须重新更新参考图reference image与对齐标记低于10可能导致系统不稳定配套资料OV2640 / OV5640 传感器数据手册引用联动注意摄像头类参数修改会直接影响后续 Alignment 与 ROI 标注故被列为 Expert 参数。同样System/SetupMode.md 则展示了另一类特征它是隐藏参数不在 Web 配置界面暴露置为true后设备下次启动仍停留在 Setup 模式——这类参数只能通过直接编辑config.ini修改。六、实战建议如何安全地修改参数结合overview.md的语义与源码证据给出可落地的操作准则先查文档再动手任何参数修改前先到 param-docs/parameter-pages/ 对应区段目录下查阅该参数页确认取值范围、默认值与 Expert 警告区分三类参数普通参数可界面配置、Expert 参数需理解原理、常伴随联动影响、UI 隐藏参数仅能直改 config.ini善用复选框语义在 Web 配置界面取消勾选某区段/参数等价于关闭该功能或回退默认值无需删除配置行留意NUMBER.前缀参数如NUMBER.ChangeRateThreshold、NUMBER.MaxRateType对应默认配置中的main.ChangeRateThreshold 2、main.MaxRateValue 0.05修改前需确认是全局统一还是按表计覆盖修改传感器/图像类参数后如CamQuality等会影响图像输出务必按警告重新执行参考图与对齐标记的更新流程遵循新增即补文档约定若在配置中新增参数应同步在parameter-pages下建立描述页并运行生成脚本补全模板保证 Tooltip 与在线文档不缺失。七、总结overview.md虽然只是简短的一页但它锚定了 AI-on-the-edge-device 整个参数体系的三个关键事实参数以 config.ini 为唯一事实源、参数/区段的复选框决定启用状态与默认值回退、参数文档由模板脚本自动生成并与 Web 界面 Tooltip 联动。以它为入口配合 sd-card/config/config.ini、param-docs/parameter-pages/ 与 generate-template-param-doc-pages.py开发者可以快速定位、理解并安全地配置这个老旧表计数字化项目中从摄像头、识别模型到数据上报的全部参数。【免费下载链接】AI-on-the-edge-deviceEasy to use device for connecting old measuring units (water, power, gas, ...) to the digital world项目地址: https://gitcode.com/GitHub_Trending/ai/AI-on-the-edge-device创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考