HHKBAssistant_for_mac 项目教程

HHKBAssistant_for_mac 项目教程

HHKBAssistant_for_macA funny helper tool for HHKB professional keyboard on mac. Its main job is that it can auto detect the HHKB professional keyboard plugged in and out, and do some actions you want.项目地址:https://gitcode.com/gh_mirrors/hh/HHKBAssistant_for_mac

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

HHKBAssistant_for_mac/
├── README.md
├── src/
│   ├── main.py
│   ├── config.py
│   ├── utils/
│   │   ├── helper.py
│   │   └── logger.py
│   └── modules/
│       ├── keyboard.py
│       └── system.py
└── tests/
    ├── test_config.py
    └── test_keyboard.py

• README.md: 项目说明文件，包含项目的基本信息和使用指南。
• src/: 源代码目录，包含项目的所有源代码文件。
  • main.py: 项目的启动文件。
  • config.py: 项目的配置文件。
  • utils/: 工具模块目录，包含辅助函数和日志记录工具。
    • helper.py: 辅助函数文件。
    • logger.py: 日志记录工具文件。
  • modules/: 功能模块目录，包含键盘和系统相关的功能实现。
    • keyboard.py: 键盘功能实现文件。
    • system.py: 系统功能实现文件。
• tests/: 测试目录，包含项目的测试文件。
  • test_config.py: 配置文件的测试文件。
  • test_keyboard.py: 键盘功能测试文件。

2. 项目的启动文件介绍

main.py 是项目的启动文件，负责初始化配置和启动主程序。以下是 main.py 的主要内容：

import config
from modules.keyboard import KeyboardHandler
from modules.system import SystemHandler

def main():
    # 加载配置
    cfg = config.load_config()
    
    # 初始化键盘处理器
    keyboard_handler = KeyboardHandler(cfg)
    
    # 初始化系统处理器
    system_handler = SystemHandler(cfg)
    
    # 启动键盘监听
    keyboard_handler.start()
    
    # 启动系统监控
    system_handler.start()

if __name__ == "__main__":
    main()

• 导入模块: 导入了配置文件、键盘处理器和系统处理器。
• 加载配置: 从 config.py 中加载配置信息。
• 初始化处理器: 初始化键盘和系统处理器。
• 启动监听: 启动键盘监听和系统监控。

3. 项目的配置文件介绍

config.py 是项目的配置文件，负责加载和管理配置信息。以下是 config.py 的主要内容：

import json

def load_config():
    with open('config.json', 'r') as f:
        config = json.load(f)
    return config

def save_config(config):
    with open('config.json', 'w') as f:
        json.dump(config, f, indent=4)

• 加载配置: 从 config.json 文件中加载配置信息。
• 保存配置: 将配置信息保存到 config.json 文件中。

配置文件 config.json 的示例内容如下：

{
    "keyboard": {
        "layout": "US",
        "sensitivity": 5
    },
    "system": {
        "log_level": "INFO",
        "update_interval": 60
    }
}

• keyboard: 键盘配置，包括布局和灵敏度。
• system: 系统配置，包括日志级别和更新间隔。

HHKBAssistant_for_macA funny helper tool for HHKB professional keyboard on mac. Its main job is that it can auto detect the HHKB professional keyboard plugged in and out, and do some actions you want.项目地址:https://gitcode.com/gh_mirrors/hh/HHKBAssistant_for_mac