快速上手
安装
最简单的方法是通过以下方式将 @wdio/ocr-service 作为依赖项保存在您的 package.json 中。
- npm
- Yarn
- pnpm
npm install @wdio/ocr-service --save-dev
yarn add @wdio/ocr-service --dev
pnpm add @wdio/ocr-service --save-dev
有关如何安装 WebdriverIO 的说明，请参见此处。
注意
此模块使用 Tesseract 作为 OCR 引擎。默认情况下，它会验证您的系统上是否安装了 Tesseract 的本地安装，如果是，则会使用它。否则，它将使用Node.js Tesseract.js模块，该模块会自动为您安装。
如果您想加快图像处理速度，建议使用本地安装的 Tesseract 版本。另请参见测试执行时间。
有关如何在本地系统上将 Tesseract 作为系统依赖项安装的说明，请参见此处。
警告
有关 Tesseract 的安装问题/错误，请参阅Tesseract项目。
TypeScript 支持
确保您将 @wdio/ocr-service 添加到您的 tsconfig.json 配置文件中。
tsconfig.json
{
"compilerOptions": {
"types": ["node", "@wdio/globals/types", "@wdio/ocr-service"]
}
}
配置
要使用此服务，您需要在 wdio.conf.ts 中的 services 数组中添加 ocr。
// wdio.conf.js
exports.config = {
//...
services: [
// your other services
[
"ocr",
{
contrast: 0.25,
imagesFolder: ".tmp/",
language: "eng",
},
],
],
};
配置选项
contrast
- 类型：
number - 是否必填：否
- 默认值：
0.25
对比度越高，图像越暗，反之亦然。这可以帮助在图像中找到文本。它接受 -1 到 1 之间的值。
imagesFolder
- 类型：
string - 是否必填：否
- 默认值：
{project-root}/.tmp/ocr
存储 OCR 结果的文件夹。
注意
如果您提供自定义的 imagesFolder，则服务会自动在其下添加子文件夹 ocr。
language
- 类型：
string - 是否必填：否
- 默认值：
eng
Tesseract 将识别的语言。更多信息请参见此处，支持的语言请参见此处。
日志
此模块会自动将额外的日志添加到 WebdriverIO 日志中。它使用名称 @wdio/ocr-service 写入 INFO 和 WARN 日志。以下提供了一些示例。
...............
[0-0] 2024-05-24T06:55:12.739Z INFO @wdio/ocr-service: Adding commands to global browser
[0-0] 2024-05-24T06:55:12.750Z INFO @wdio/ocr-service: Adding browser command "ocrGetText" to browser object
[0-0] 2024-05-24T06:55:12.751Z INFO @wdio/ocr-service: Adding browser command "ocrGetElementPositionByText" to browser object
[0-0] 2024-05-24T06:55:12.751Z INFO @wdio/ocr-service: Adding browser command "ocrWaitForTextDisplayed" to browser object
[0-0] 2024-05-24T06:55:12.751Z INFO @wdio/ocr-service: Adding browser command "ocrClickOnText" to browser object
[0-0] 2024-05-24T06:55:12.751Z INFO @wdio/ocr-service: Adding browser command "ocrSetValue" to browser object
...............
[0-0] 2024-05-24T06:55:13.667Z INFO @wdio/ocr-service:getData: Using system installed version of Tesseract
[0-0] 2024-05-24T06:55:14.019Z INFO @wdio/ocr-service:getData: It took '0.351s' to process the image.
[0-0] 2024-05-24T06:55:14.019Z INFO @wdio/ocr-service:getData: The following text was found through OCR:
[0-0]
[0-0] IQ Docs API Blog Contribute Community Sponsor Next-gen browser and mobile automation Welcome! How can | help? i test framework for Node.js Get Started Why WebdriverI0? View on GitHub Watch on YouTube
[0-0] 2024-05-24T06:55:14.019Z INFO @wdio/ocr-service:getData: OCR Image with found text can be found here:
[0-0]
[0-0] .tmp/ocr/desktop-1716533713585.png
[0-0] 2024-05-24T06:55:14.019Z INFO @wdio/ocr-service:ocrGetElementPositionByText: We searched for the word "Get Started" and found one match "Started" with score "63.64
...............
