Printrun 技术文档

1. 安装指南

1.1 预编译二进制包和软件包

1.1.1 Windows 和 macOS 预编译二进制包

可以从以下地址下载最新的预编译包：https://github.com/kliment/Printrun/releases/latest

注意： macOS 用户可能会遇到“无法验证开发者”的提示，此时可以通过右键点击应用并选择“打开”来解决。

1.1.2 Linux 官方仓库中的软件包

Ubuntu / Mint / Raspberry Pi OS / Debian

安装完整套件：

sudo apt install printrun

或者只安装需要的应用：

sudo apt install pronsole

或

sudo apt install pronterface

Fedora

安装完整套件：

sudo dnf install printrun

或者只安装需要的应用：

sudo dnf install pronsole

或

sudo dnf install pronterface

Arch Linux

可以通过 AUR 安装：

yaourt printrun

1.2 从源码运行

1.2.1 Linux / macOS

1. 安装 Python

   大多数 Linux 发行版已经预装了 Python。如果没有，可以通过包管理器安装。macOS 用户可以从 python.org 下载并安装最新版本的 Python。

2. 下载最新的 Printrun 源码

   在终端中运行以下命令：

   git clone https://github.com/kliment/Printrun.git
   cd Printrun
   

3. 使用 Python 虚拟环境

   建议使用虚拟环境以避免与其他 Python 库冲突。在 Printrun 根目录下创建并激活虚拟环境：

   python -m venv venv
   source venv/bin/activate
   

4. 安装 Printrun

   激活虚拟环境后，运行以下命令安装 Printrun：

   python -m pip install .
   

5. 运行 Printrun

   激活虚拟环境后，运行所需的应用：

   pronterface.py
   

1.2.2 Windows

1. 安装必要的软件

   下载并安装 GIT for Windows、Python 3.10 和 C-compiler environment。

2. 下载源码并编译

   在 CMD 或 PowerShell 中运行以下命令：

   git clone https://github.com/kliment/Printrun.git
   cd Printrun
   release_windows.bat
   

3. 运行应用

   编译完成后，可以在 dist 目录中找到 Pronterface.exe 和 Pronsole.exe。

2. 项目使用说明

2.1 使用 Pronterface

设置完成后，可以在解压后的目录中启动 pronterface.py。选择端口名称和波特率，点击连接。加载 STL 或 GCODE 文件后，可以直接打印或上传到 SD 卡。

2.2 使用 Pronsole

pronsole.py 是一个交互式命令行主机，支持 Tab 补全功能。

2.3 使用 Printcore

printcore.py 是一个库，使得编写 RepRap 主机变得简单。

2.4 使用 Platers

Platers 是一个帮助脚本集合，用于处理 3D 打印机的相关任务。

3. 项目 API 使用文档

3.1 printcore.py

printcore.py 提供了与 3D 打印机通信的 API，开发者可以通过该库轻松编写自定义的 3D 打印机主机。

3.2 pronsole.py

pronsole.py 提供了命令行接口，支持多种命令和 Tab 补全功能。

3.3 pronterface.py

pronterface.py 提供了图形化界面，功能与 pronsole.py 相同。

4. 项目安装方式

4.1 预编译包安装

可以从 GitHub 下载预编译的二进制包，或者通过操作系统的包管理器安装。

4.2 源码安装

通过克隆 GitHub 仓库并运行安装脚本，可以从源码安装 Printrun。