ET99多功能锁API接口说明文档

### ET99多功能锁API接口说明知识点 #### 第一章 概述 - **文档目的**：该文档旨在详尽地介绍ET99多功能锁API接口的各项功能与使用方法，并提供必要的常量定义，帮助开发者更好地理解和应用这些API。通过本手册，开发者能够有效地与ET99多功能锁进行交互，实现加密、认证等多种安全功能。 - **适用对象**：适用于所有希望利用ET99多功能锁API接口进行二次开发的软件工程师和技术人员。 - **文档结构**：手册主要分为两大部分——API函数接口和常量定义。API函数接口部分详细介绍了各个可用的API函数及其参数、返回值等信息；常量定义部分则列举了开发过程中可能用到的各种预定义常量。 #### 第二章 API函数接口 - **2.1 查找ET99** - **函数名**：`et_FindToken` - **功能说明**：此函数用于查找当前计算机系统中已连接的指定PID的ET99多功能锁的数量。 - **参数**： - `pid`：输入参数，指定要查找的ET99多功能锁的产品标识符，为8个字节的字符串。 - `count`：输出参数，返回查找到的ET99多功能锁的数量。 - **返回值**： - `ET_SUCCESS`：表示操作成功，`count`变量中存储了查找到的ET99多功能锁的数量。 - `ET_UNIT_NOT_FOUND`：表示未找到可用的硬件，此时`count`值为0。 - **2.2 打开锁** - **函数名**：`et_OpenToken` - **功能说明**：此函数用于打开指定PID的ET99多功能锁，进入匿名用户状态。 - **参数**： - `hHandle`：输出参数，返回一个打开设备的句柄，用于后续对该设备的操作。 - `pid`：输入参数，指定要打开的ET99多功能锁的产品标识符。 - `ind`：输入参数，指定打开硬件的索引，该值应小于或等于通过`et_FindToken`函数获取的设备数量。 - **返回值**： - 成功打开设备后返回`ET_SUCCESS`，并可以通过`hHandle`参数获取句柄。 - 其他情况下，返回相应的错误代码。 - **2.3 关闭设备** - **函数名**：`et_CloseToken` - **功能说明**：此函数用于关闭之前通过`et_OpenToken`函数打开的ET99多功能锁。 - **参数**： - `hHandle`：输入参数，指定了要关闭的设备的句柄。 - **返回值**： - 成功关闭设备后返回`ET_SUCCESS`。 - 如果句柄无效或出现其他错误，则返回相应的错误代码。 - **2.4 读取存储区** - **函数名**：`et_ReadStorage` - **功能说明**：此函数用于从ET99多功能锁中读取指定地址的数据。 - **参数**： - `hHandle`：输入参数，指定了要读取数据的设备的句柄。 - `address`：输入参数，指定了要读取数据的起始地址。 - `data`：输出参数，用于存储读取到的数据。 - `length`：输入参数，指定了要读取的数据长度。 - **返回值**： - 成功读取数据后返回`ET_SUCCESS`。 - 如果读取失败，则返回相应的错误代码。 - **2.5 写入存储区** - **函数名**：`et_WriteStorage` - **功能说明**：此函数用于向ET99多功能锁中写入数据。 - **参数**： - `hHandle`：输入参数，指定了要写入数据的设备的句柄。 - `address`：输入参数，指定了要写入数据的起始地址。 - `data`：输入参数，指定了要写入的数据。 - `length`：输入参数，指定了要写入的数据长度。 - **返回值**： - 成功写入数据后返回`ET_SUCCESS`。 - 如果写入失败，则返回相应的错误代码。 - **2.6 产生产品标识** - **函数名**：`et_GenerateProductID` - **功能说明**：此函数用于生成一个新的产品标识符。 - **参数**： - `hHandle`：输入参数，指定了要生成产品标识符的设备的句柄。 - `productID`：输出参数，用于存储生成的产品标识符。 - **返回值**： - 成功生成产品标识符后返回`ET_SUCCESS`。 - 如果生成失败，则返回相应的错误代码。 - **2.7 产生随机数** - **函数名**：`et_GenerateRandomNumber` - **功能说明**：此函数用于生成一个随机数。 - **参数**： - `hHandle`：输入参数，指定了要生成随机数的设备的句柄。 - `randomNumber`：输出参数，用于存储生成的随机数。 - `length`：输入参数，指定了随机数的长度。 - **返回值**： - 成功生成随机数后返回`ET_SUCCESS`。 - 如果生成失败，则返回相应的错误代码。 - **2.8 产生超级用户PIN码** - **函数名**：`et_GenerateSuperUserPIN` - **功能说明**：此函数用于生成超级用户的PIN码。 - **参数**： - `hHandle`：输入参数，指定了要生成超级用户PIN码的设备的句柄。 - `pin`：输出参数，用于存储生成的超级用户PIN码。 - **返回值**： - 成功生成超级用户PIN码后返回`ET_SUCCESS`。 - 如果生成失败，则返回相应的错误代码。 - **2.9 重置普通用户PIN码** - **函数名**：`et_ResetUserPIN` - **功能说明**：此函数用于重置普通用户的PIN码。 - **参数**： - `hHandle`：输入参数，指定了要重置普通用户PIN码的设备的句柄。 - `newPin`：输入参数，指定了新的PIN码。 - **返回值**： - 成功重置PIN码后返回`ET_SUCCESS`。 - 如果重置失败，则返回相应的错误代码。 - **2.10 设置密钥** - **函数名**：`et_SetKey` - **功能说明**：此函数用于设置ET99多功能锁中的密钥。 - **参数**： - `hHandle`：输入参数，指定了要设置密钥的设备的句柄。 - `key`：输入参数，指定了要设置的新密钥。 - **返回值**： - 成功设置密钥后返回`ET_SUCCESS`。 - 如果设置失败，则返回相应的错误代码。 - **2.11 纯软件HMAC_MD5接口** - **函数名**：`et_HMAC_MD5Software` - **功能说明**：此函数提供了纯软件实现的HMAC_MD5算法。 - **参数**： - `key`：输入参数，指定了HMAC_MD5算法使用的密钥。 - `data`：输入参数，指定了要进行HMAC_MD5运算的数据。 - `digest`：输出参数，用于存储计算得到的摘要。 - **返回值**： - 成功计算摘要后返回`ET_SUCCESS`。 - 如果计算失败，则返回相应的错误代码。 - **2.12 计算HMAC_MD5** - **函数名**：`et_HMAC_MD5` - **功能说明**：此函数用于计算HMAC_MD5摘要。 - **参数**： - `hHandle`：输入参数，指定了要进行HMAC_MD5运算的设备的句柄。 - `key`：输入参数，指定了HMAC_MD5算法使用的密钥。 - `data`：输入参数，指定了要进行HMAC_MD5运算的数据。 - `digest`：输出参数，用于存储计算得到的摘要。 - **返回值**： - 成功计算摘要后返回`ET_SUCCESS`。 - 如果计算失败，则返回相应的错误代码。 - **2.13 验证PIN码** - **函数名**：`et_VerifyPIN` - **功能说明**：此函数用于验证用户输入的PIN码是否正确。 - **参数**： - `hHandle`：输入参数，指定了要验证PIN码的设备的句柄。 - `pin`：输入参数，指定了用户输入的PIN码。 - **返回值**： - 如果PIN码正确，返回`ET_SUCCESS`。 - 如果PIN码不正确或其他错误，则返回相应的错误代码。 - **2.14 修改用户PIN码** - **函数名**：`et_ChangeUserPIN` - **功能说明**：此函数用于修改用户的PIN码。 - **参数**： - `hHandle`：输入参数，指定了要修改PIN码的设备的句柄。 - `oldPin`：输入参数，指定了旧的PIN码。 - `newPin`：输入参数，指定了新的PIN码。 - **返回值**： - 成功修改PIN码后返回`ET_SUCCESS`。 - 如果修改失败，则返回相应的错误代码。 - **2.15 重置安全状态** - **函数名**：`et_ResetSecurityStatus` - **功能说明**：此函数用于重置ET99多功能锁的安全状态。 - **参数**： - `hHandle`：输入参数，指定了要重置安全状态的设备的句柄。 - **返回值**： - 成功重置安全状态后返回`ET_SUCCESS`。 - 如果重置失败，则返回相应的错误代码。 - **2.16 获得硬件序列号** - **函数名**：`et_GetSerialNumber` - **功能说明**：此函数用于获取ET99多功能锁的硬件序列号。 - **参数**： - `hHandle`：输入参数，指定了要获取序列号的设备的句柄。 - `serialNumber`：输出参数，用于存储获取到的序列号。 - **返回值**： - 成功获取序列号后返回`ET_SUCCESS`。 - 如果获取失败，则返回相应的错误代码。 - **2.17 配置设备** - **函数名**：`et_ConfigureDevice` - **功能说明**：此函数用于配置ET99多功能锁的各项设置。 - **参数**： - `hHandle`：输入参数，指定了要配置的设备的句柄。 - `setting`：输入参数，指定了具体的配置项。 - **返回值**： - 成功配置后返回`ET_SUCCESS`。 - 如果配置失败，则返回相应的错误代码。 - **2.18 打开LED灯** - **函数名**：`et_OpenLED` - **功能说明**：此函数用于打开ET99多功能锁上的LED灯。 - **参数**： - `hHandle`：输入参数，指定了要打开LED灯的设备的句柄。 - **返回值**： - 成功打开LED灯后返回`ET_SUCCESS`。 - 如果打开失败，则返回相应的错误代码。 - **2.19 关闭LED灯** - **函数名**：`et_CloseLED` - **功能说明**：此函数用于关闭ET99多功能锁上的LED灯。 - **参数**： - `hHandle`：输入参数，指定了要关闭LED灯的设备的句柄。 - **返回值**： - 成功关闭LED灯后返回`ET_SUCCESS`。 - 如果关闭失败，则返回相应的错误代码。 #### 第三章 常量定义 - **3.1 接口函数的返回值** - `ET_SUCCESS`：表示操作成功。 - `ET_UNIT_NOT_FOUND`：表示未找到指定的硬件单元。 - `ET_INVALID_PARAMETER`：表示函数调用时参数无效。 - `ET_OPERATION_FAILED`：表示操作失败。 - `ET_MEMORY_ERROR`：表示内存分配错误。 - **3.2 PIN码标志** - `ET_PIN_NORMAL_USER`：表示普通用户PIN码。 - `ET_PIN_SUPER_USER`：表示超级用户PIN码。 - `ET_PIN_ADMINISTRATOR`：表示管理员PIN码。 - **3.3 数据区的读写标志** - `ET_READ_ONLY`：表示只读访问模式。 - `ET_WRITE_ONLY`：表示只写访问模式。 - `ET_READ_WRITE`：表示可读写访问模式。 - **3.4 常量PID** - `ET_PID_ET99`：表示ET99多功能锁的产品标识符。 通过以上知识点的总结，我们可以看到ET99多功能锁API接口涵盖了从设备检测到数据操作再到安全管理的多个方面，为开发者提供了强大的工具集来构建基于ET99多功能锁的应用程序。开发者可以根据具体需求选择合适的API函数来进行二次开发，从而充分利用ET99多功能锁的功能。