Pierwsze Kroki

Instalacja

Najłatwiejszym sposobem jest utrzymanie @wdio/ocr-service jako zależności w twoim pliku package.json poprzez.

npm

npm install @wdio/ocr-service --save-dev

Yarn

yarn add @wdio/ocr-service --dev

pnpm

pnpm add @wdio/ocr-service --save-dev

Instrukcje dotyczące instalacji WebdriverIO można znaleźć tutaj.

notatka

Ten moduł używa Tesseract jako silnika OCR. Domyślnie sprawdzi, czy masz lokalną instalację Tesseract na swoim systemie, jeśli tak, użyje jej. Jeśli nie, użyje modułu Node.js Tesseract.js, który jest automatycznie instalowany za ciebie.

Jeśli chcesz przyspieszyć przetwarzanie obrazów, zaleca się korzystanie z lokalnie zainstalowanej wersji Tesseract. Zobacz także Czas wykonania testu.

Instrukcje dotyczące instalacji Tesseract jako zależności systemowej na twoim lokalnym systemie można znaleźć tutaj.

ostrożnie

W przypadku pytań/błędów związanych z instalacją Tesseract, prosimy o zapoznanie się z projektem Tesseract.

Wsparcie Typescript

Upewnij się, że dodałeś @wdio/ocr-service do swojego pliku konfiguracyjnego tsconfig.json.

tsconfig.json

{
    "compilerOptions": {
        "types": ["node", "@wdio/globals/types", "@wdio/ocr-service"]
    }
}

Konfiguracja

Aby korzystać z usługi, musisz dodać ocr do tablicy usług w wdio.conf.ts

// wdio.conf.js
exports.config = {
    //...
    services: [
        // your other services
        [
            "ocr",
            {
                contrast: 0.25,
                imagesFolder: ".tmp/",
                language: "eng",
            },
        ],
    ],
};

Opcje konfiguracji

contrast

• Typ: number
• Obowiązkowe: Nie
• Domyślnie: 0.25

Im wyższy kontrast, tym ciemniejszy obraz i odwrotnie. Może to pomóc w znalezieniu tekstu na obrazie. Akceptuje wartości od -1 do 1.

imagesFolder

• Typ: string
• Obowiązkowe: Nie
• Domyślnie: {project-root}/.tmp/ocr

Folder, w którym przechowywane są wyniki OCR.

notatka

Jeśli podasz niestandardowy imagesFolder, usługa automatycznie doda do niego podfolder ocr.

language

• Typ: string
• Obowiązkowe: Nie
• Domyślnie: eng

Język, który Tesseract będzie rozpoznawać. Więcej informacji można znaleźć tutaj, a obsługiwane języki można znaleźć tutaj.

Logi

Ten moduł automatycznie dodaje dodatkowe logi do logów WebdriverIO. Zapisuje do logów INFO i WARN z nazwą @wdio/ocr-service. Przykłady można znaleźć poniżej.

...............
[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
...............