# tyidcard-android-sdk

**Repository Path**: gdty/tyidcard-android-sdk

## Basic Information

- **Project Name**: tyidcard-android-sdk
- **Description**: 用于Android平台的身份证读取SDK，支持身份证信息的读取与处理。
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-27
- **Last Updated**: 2025-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Gitea

## README

# tyidcard-android-sdk

这是一个用于Android平台的身份证读取SDK，支持身份证信息的读取与处理。

## 功能特性

- 支持身份证信息读取
- 提供身份证信息的封装与转换
- 支持指纹信息处理
- 提供图片处理工具类
- 支持通过JNI调用本地库进行图像处理

## 构建项目

你可以使用Android Studio进行构建，或者在根目录执行以下命令：

```bash
./gradlew --project-dir lib clean
./gradlew --project-dir lib build
```

## 使用方法

### 引入SDK

在你的`build.gradle`文件中添加如下依赖：

```gradle
repositories {
    maven { url 'https://maven.cnb.cool/gdteyu/gradle/-/packages/' }
}

dependencies {
    implementation 'com.gdty.idcard:tyidcard-android-sdk:1.1.2'
}
```

### 调用示例

请参考单元测试中的调用示例，主要的调用流程如下：

1. 初始化身份证读取器：

   ```java
   IdcardHelper.initIDCardReader(context);
   ```

2. 打开读卡器：

   ```java
   IdcardHelper.open();
   ```

3. 查找卡片：

   ```java
   boolean cardFound = IdcardHelper.findCard();
   ```

4. 选择卡片：

   ```java
   boolean cardSelected = IdcardHelper.selectCard();
   ```

5. 读取卡片信息：

   ```java
   int readResult = IdcardHelper.readCardEx(action);
   ```

6. 获取读取到的身份证信息：

   ```java
   TyIDCardInfo cardInfo = IdcardHelper.getInfo();
   ```

7. 销毁读卡器：

   ```java
   IdcardHelper.destroy();
   ```

## 工具与辅助类

- `Convert`：提供身份证信息转换功能。
- `IDPhotoHelper`：提供身份证照片处理功能。
- `ImageUtils`：提供图片与Base64字符串之间的转换功能。
- `FpUtils`：提供指纹信息处理功能。
- `FPTypeUtils`：定义指纹类型枚举。

## 本地库支持

本SDK依赖以下本地库：

- `libpower.so`
- `libwlt2bmp.so`
- `libzkserialport.so`
- `libzkwltdecode.so`

这些库用于处理底层的硬件交互与图像解码。

## 许可证

本项目遵循开源许可协议，请参考项目中的 LICENSE 文件获取详细信息。