btrfld 项目安装与配置指南

btrfld 项目安装与配置指南

btrfld a folding, tenting wireless keyboard 项目地址: https://gitcode.com/gh_mirrors/bt/btrfld

1. 项目基础介绍

btrfld 是一个开源项目，它是一种可折叠的便携式键盘，拥有创新的折叠设计和人体工程学布局。该项目主要由 SolidHal 开发，并托管在 GitHub 上。btrfld 的主要编程语言包括 C 和 Python，主要用于键盘固件的开发。

2. 项目使用的关键技术和框架

• 键盘固件开发：使用 ZMK (Zephyr Microkernel) 固件，它是一个为微控制器设计的实时操作系统。
• 3D建模：使用 FreeCad 进行键盘外壳和零件的设计。
• PCB设计：使用 KiCad 进行电路板的设计。
• 编程语言：C 语言用于固件的编写，Python 用于一些自动化脚本和配置。

3. 项目安装和配置的准备工作

在开始安装和配置之前，请确保您的系统满足以下要求：

• 操作系统：建议使用 Linux 或 macOS，Windows 用户可能需要使用 WSL（Windows Subsystem for Linux）。
• 工具安装：
  • Git：用于克隆和操作项目代码。
  • CMake：用于构建项目。
  • west：Zephyr 项目管理的命令行工具。
  • Docker：用于运行 Zephyr 的构建环境。
  • Python 和相关库：用于运行自动化脚本。
• 硬件：确保您有一个支持蓝牙的微控制器，如 bluemicro840 或 nicenano。

安装步骤

克隆项目

首先，您需要克隆 btrfld 项目：

git clone https://github.com/SolidHal/btrfld.git
cd btrfld

安装依赖

安装必要的依赖项：

sudo apt-get update
sudo apt-get install git cmake ninja-python3 git-lfs

安装 Docker 和相关依赖：

sudo apt-get install docker.io
sudo systemctl start docker
sudo systemctl enable docker

安装 west：

pip3 install west

配置环境

设置 Zephyr 的构建环境：

west init -l zephyrproject-ncs.git
west update

构建固件

构建 btrfld 的固件：

cd zmk
cd app
west build -b bluemicro840_v1 -- -DSHIELD=btrfld

烧录固件

将构建好的固件烧录到微控制器上：

sudo west flash

确保您的微控制器通过 USB 连接到计算机，并且已经进入了引导模式。

测试键盘

在烧录完固件后，您可以测试键盘是否正常工作。

以上就是 btrfld 项目的详细安装和配置指南。如果您在安装过程中遇到任何问题，请参考项目文档或向项目维护者寻求帮助。

btrfld a folding, tenting wireless keyboard 项目地址: https://gitcode.com/gh_mirrors/bt/btrfld