Footswitch 项目技术文档

本文档旨在帮助用户了解并使用 Footswitch 项目，该项目的目的是为 PCsensor 和 Scythe 脚踏开关提供命令行编程工具。

1. 安装指南

Debian 系统安装

在 Debian 系统上，确保已安装 devscripts 和 equivs：

mk-build-deps -i
dpkg-buildpackage -us -uc -b

或者，可以在 Docker 容器中构建包：

docker build .

Archlinux 系统安装

Footswitch 在 Arch User Repository (AUR) 中可用，可以使用您喜欢的 AUR 辅助程序安装，例如：

• yay -S footswitch-git
• paru -S footswitch-git

其他系统安装

该项目使用 hidapi 库，应在 Linux 和 OSX 上工作。在 Linux 上构建：

sudo apt-get install libhidapi-dev
git clone https://github.com/rgerganov/footswitch.git
cd footswitch
make
sudo make install

install 目标在 Linux 上安装 udev 规则，允许无需 root 权限运行程序。否则可能需要使用 sudo。

在 OSX 上构建：

brew tap rgerganov/footswitch https://github.com/rgerganov/footswitch.git
brew install --HEAD footswitch

2. 项目使用说明

本项目提供两个主要命令行工具：footswitch 和 scythe，用于编程脚踏开关。

Footswitch 使用说明

footswitch [-123] [-r] [-s <字符串>] [-S <原始字符串>] [-ak <键>] [-m <修饰符>] [-b <按钮>] [-xyw <XYW>]

• -r：读取所有踏板的持久功能并打印到控制台。
• -1、-2、-3：分别编程第一个、第二个或第三个踏板。
• -s <字符串>：将指定的字符串附加到踏板功能。
• -S <原始字符串>：将指定的原始字符串（由空格分隔的十六进制数字）附加到踏板功能。
• -a <键>：将指定的键附加到踏板功能。
• -k <键>：将指定的键写入踏板功能。
• -m <修饰符>：指定修饰符，如 ctrl|shift|alt|win。
• -b <按钮>：指定鼠标按钮，如 mouse_left|mouse_middle|mouse_right。
• -x <X>：将鼠标光标水平移动 X 像素。
• -y <Y>：将鼠标光标垂直移动 Y 像素。
• -w <W>：将鼠标滚轮移动 W。

Scythe 使用说明

scythe [-123] [-r] [-a <键>] [-m <修饰符>] [-b <按钮>]

• -r：读取所有踏板的持久功能并打印到控制台。
• -1、-2、-3：分别编程第一个、第二个或第三个踏板。
• -a <键>：将指定的键附加到踏板功能。
• -m <修饰符>：指定修饰符，如 ctrl|shift|alt|win。
• -b <按钮>：指定鼠标按钮，如 mouse_left|mouse_double|mouse_right。

使用示例

请参考以下使用示例进行操作：

PCsensor 示例

footswitch -r
footswitch -k a
footswitch -1 -k a -2 -k b -3 -k c
footswitch -1 -k esc -2 -k enter
footswitch -1 -m ctrl -k a -3 -m alt -k f4
footswitch -1 -m ctrl -k a -3 -m shift -m alt -k s
footswitch -m ctrl -b mouse_middle
footswitch -s 'hello world'
footswitch -s 'hello' -s ' ' -s 'world'
footswitch -a esc -a i
footswitch -s ls -a enter
footswitch -S '29 C'
footswitch -1 -x 10 -2 -w 15 -3 -y -10

Scythe 示例

scythe -r
scythe -1 -a a -2 -a b -3 -a c
scythe -1 -m ctrl -a h -a o -2 -m alt -a f4 -3 -b mouse_double

3. 项目API使用文档

本项目未提供专门的 API 文档，但用户可以通过阅读项目源代码和查看命令行工具的使用说明来了解如何使用项目。

4. 项目安装方式

请参考上文中的“安装指南”部分进行安装。