Démarrage

Installation

La façon la plus simple est de garder @wdio/ocr-service comme dépendance dans votre package.json via.

npm

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

Yarn

yarn add @wdio/ocr-service --dev

pnpm

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

Les instructions sur comment installer WebdriverIO peuvent être trouvées ici.

note

Ce module utilise Tesseract comme moteur OCR. Par défaut, il vérifiera si vous avez une installation locale de Tesseract sur votre système, si c'est le cas, il l'utilisera. Sinon, il utilisera le module Node.js Tesseract.js qui est automatiquement installé pour vous.

Si vous souhaitez accélérer le traitement d'image, il est conseillé d'utiliser une version localement installée de Tesseract. Voir aussi Temps d'exécution des tests.

Les instructions sur comment installer Tesseract comme dépendance système sur votre système local peuvent être trouvées ici.

attention

Pour les questions/erreurs d'installation avec Tesseract, veuillez vous référer au projet Tesseract.

Support Typescript

Assurez-vous d'ajouter @wdio/ocr-service à votre fichier de configuration tsconfig.json.

tsconfig.json

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

Configuration

Pour utiliser le service, vous devez ajouter ocr à votre tableau de services dans wdio.conf.ts

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

Options de configuration

contrast

• Type: number
• Obligatoire: Non
• Défaut: 0.25

Plus le contraste est élevé, plus l'image est sombre et vice versa. Cela peut aider à trouver du texte dans une image. Il accepte des valeurs entre -1 et 1.

imagesFolder

• Type: string
• Obligatoire: Non
• Défaut: {project-root}/.tmp/ocr

Le dossier où les résultats OCR sont stockés.

note

Si vous fournissez un imagesFolder personnalisé, le service ajoutera automatiquement le sous-dossier ocr.

language

• Type: string
• Obligatoire: Non
• Défaut: eng

La langue que Tesseract reconnaîtra. Plus d'informations peuvent être trouvées ici et les langues prises en charge peuvent être trouvées ici.

Logs

Ce module ajoutera automatiquement des logs supplémentaires aux logs WebdriverIO. Il écrit dans les logs INFO et WARN avec le nom @wdio/ocr-service. Des exemples peuvent être trouvés ci-dessous.

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