OctoPrint-DisplayLayerProgress插件安装与配置指南

OctoPrint-DisplayLayerProgress是一款专为OctoPrint设计的插件，它通过M117命令将打印进度、当前层信息以及其他相关数据发送至打印机显示屏以及浏览器顶部导航栏，增强了打印过程中的交互体验。

1. 项目目录结构及介绍

项目在GitHub上的主目录遵循典型的Python项目布局，以下是关键组件简介：

• octoprint_DisplayLayerProgress: 主要的插件实现代码所在目录。
  • 包含核心逻辑处理文件如__init__.py，该文件初始化插件。
  • 可能还含有其他用于特定功能的.py文件。
• MANIFEST.in: 指定了构建分发包时应包含的非Python文件。
• setup.py: 插件的安装脚本，用于设置插件的基本元数据和依赖项。
• README.md: 包含插件的介绍、功能、安装和使用说明的重要文件。
• LICENSE.txt: 许可证文件，表明该项目遵循AGPL-3.0许可协议。
• translations: 包含插件的多语言翻译文件。
• screenshots: 展示插件界面或效果的截图。
• .gitignore: Git忽略文件，定义不应纳入版本控制的文件类型或文件夹。

2. 项目的启动文件介绍

虽然OctoPrint插件并没有一个直接的“启动文件”像传统应用那样，其激活和运行是基于OctoPrint框架进行的。当你在OctoPrint中启用此插件后，关键的启动逻辑主要由octoprint_DisplayLayerProgress/__init__.py文件负责，其中初始化插件并注册各种事件处理器和钩子（hooks），使得插件能在适当的时机（比如G代码上传、打印进程更新时）执行其功能。

3. 项目的配置文件介绍

配置方式

配置主要不是通过独立的配置文件，而是利用OctoPrint的内置插件管理界面来进行。安装插件后，你可以通过OctoPrint的设置页面找到此插件的配置选项。

核心配置点可能包括：

• Layer Expression: 定义层指示符的正则表达式，以匹配特定切片器的层指示。
• Output Pattern: 调整显示在打印机屏幕和导航栏的信息格式。
• Enable/disable G-code upload preprocessing: 是否在上传G代码时修改G码以包含进度信息。
• WebSocket Settings: 如果启用了WebSocket，这里可以配置客户端接收实时数据的设置。
• Advanced Options: 其他高级配置，如支持的额外功能或定制行为。

由于配置直接在OctoPrint UI中完成，无需手动编辑文本配置文件。对于更复杂或高级的自定义需求，有时可以通过编辑OctoPrint的用户设置或者使用插件提供的API来进一步微调。

请注意，在调整配置后，某些更改可能需要重新上传G代码或重启OctoPrint服务以生效。务必参考插件的最新文档或GitHub仓库的readme文件获取最准确的配置指导。