Goodix FP Dump 项目技术文档

Goodix FP Dump 项目技术文档

goodix-fp-dump All our work to make Goodix fingerprint sensors work on Linux. Thanks to @markusressel and @PJungkamp for sponsoring. 项目地址: https://gitcode.com/gh_mirrors/go/goodix-fp-dump

1. 安装指南

环境要求

• Python 3.10 或更新版本

安装步骤

1. 克隆项目仓库：

   git clone --recurse-submodules https://github.com/goodix-fp-linux-dev/goodix-fp-dump.git
   

2. 进入项目目录：

   cd goodix-fp-dump
   

3. 创建虚拟环境并激活：

   python -m venv .venv
   source .venv/bin/activate
   

4. 安装依赖包：

   pip install -r requirements.txt
   

2. 项目的使用说明

注意事项

• 该项目目前处于非常不稳定的状态，不建议在生产环境中使用。
• 由于项目的不稳定性，可能会导致程序执行被禁用，请谨慎使用。
• 请勿重复创建已知问题的issue，开发者已知晓这些问题。

使用步骤

1. 检查设备ID：

   sudo lsusb -vd "27c6:" | grep "idProduct"
   

   该命令将返回设备的ID。

2. 运行脚本：

   sudo python3 run_5110.py
   

   请将5110替换为你的设备ID。

3. 项目API使用文档

API概述

该项目目前主要通过命令行脚本进行操作，API文档将在项目稳定后提供。

主要脚本

• run_5110.py：用于运行指纹传感器的主要脚本，需根据设备ID进行替换。

4. 项目安装方式

源码安装

1. 克隆项目仓库：

   git clone --recurse-submodules https://github.com/goodix-fp-linux-dev/goodix-fp-dump.git
   

2. 进入项目目录：

   cd goodix-fp-dump
   

3. 创建虚拟环境并激活：

   python -m venv .venv
   source .venv/bin/activate
   

4. 安装依赖包：

   pip install -r requirements.txt
   

依赖包安装

• 使用pip安装项目所需的依赖包：

  pip install -r requirements.txt
  

设备ID获取

• 使用lsusb命令获取设备ID：

  sudo lsusb -vd "27c6:" | grep "idProduct"
  

通过以上步骤，您可以成功安装并初步使用Goodix FP Dump项目。请注意，该项目目前处于不稳定状态，建议仅在测试环境中使用。

goodix-fp-dump All our work to make Goodix fingerprint sensors work on Linux. Thanks to @markusressel and @PJungkamp for sponsoring. 项目地址: https://gitcode.com/gh_mirrors/go/goodix-fp-dump