Hotswap PCB Generator 使用教程

Hotswap PCB Generator 使用教程

hotswap_pcb_generator OpenSCAD script for generating 3D-printable hotswap keyboard PCBs. 项目地址: https://gitcode.com/gh_mirrors/ho/hotswap_pcb_generator

1. 项目的目录结构及介绍

Hotswap PCB Generator 是一个开源项目，用于生成可3D打印的键盘PCB、底板和外壳。以下是项目的目录结构及各部分的简要介绍：

hotswap_pcb_generator/
├── .vscode/                    # Visual Studio Code 配置文件
├── example_layouts/            # 示例布局文件
├── guide/                      # 指南和文档
├── img/                        # 图片资源
├── scad/                       # OpenSCAD 脚本文件
│   ├── default_layout.scad     # 默认布局文件
│   ├── layout.scad             # 布局定义文件
│   ├── parameters.scad         # 参数定义文件
│   └── README                  # OpenSCAD 脚本说明
├── script/                     # Node.js 脚本文件
│   ├── main.js                 # 主执行脚本
│   └── package.json            # Node.js 项目配置
├── stl/                        # 生成的 STL 文件
├── .gitignore                  # Git 忽略文件
├── LICENSE                     # 许可证文件
└── README.md                   # 项目说明文件

• .vscode/: 包含 Visual Studio Code 项目的配置文件。
• example_layouts/: 包含多个示例布局文件，用于展示不同的键盘布局设计。
• guide/: 包含项目使用指南和文档。
• img/: 包含项目相关的图片资源。
• scad/: 包含 OpenSCAD 脚本文件，用于生成 PCB、底板和外壳。
  • default_layout.scad: 默认布局文件，包含了一个示例布局。
  • layout.scad: 布局定义文件，用于定义键盘的布局。
  • parameters.scad: 参数定义文件，用于设置项目的各种参数。
• script/: 包含 Node.js 脚本文件，用于从 KLE json 文件生成布局。
• stl/: 生成的 STL 文件，用于 3D 打印。
• .gitignore: Git 忽略文件，用于指定哪些文件和目录应该被 Git 忽略。
• LICENSE: 许可证文件，本项目使用 GPL-3.0 许可。
• README.md: 项目说明文件，包含项目的简要介绍和相关信息。

2. 项目的启动文件介绍

项目的启动主要通过 Node.js 脚本 script/main.js 来实现。以下是启动文件的基本使用方法：

1. 首先，确保您的系统中已安装 Node.js 14 或更高版本。
2. 进入 script/ 目录。
3. 运行 npm install 命令安装项目依赖。
4. 使用 npm start -- <layout json file> 命令启动脚本，其中 <layout json file> 是您想要转换的 KLE json 文件路径。

3. 项目的配置文件介绍

项目的配置主要通过 scad/parameters.scad 文件来进行。以下是配置文件的一些基本设置：

• wire_diameter: 设置矩阵行和列使用的电线直径。
• pcb/plate_thickness: 设置 PCB 和底板的厚度。
• diode_pin_angle: 设置二极管引脚的角度。
• backplate_thickness: 设置后板的厚度。

您可以根据自己的需求和打印机精度调整这些参数，以获得最佳的打印效果和组件配合。项目还提供了 default_layout.scad 文件作为示例，展示了如何使用各种自定义选项。

hotswap_pcb_generator OpenSCAD script for generating 3D-printable hotswap keyboard PCBs. 项目地址: https://gitcode.com/gh_mirrors/ho/hotswap_pcb_generator