Skip to content

Commit

Permalink
feat(plugin): add OpenALPR plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
iMicknl committed Mar 17, 2018
1 parent f1bf2fa commit e27fbf4
Showing 1 changed file with 69 additions and 0 deletions.
69 changes: 69 additions & 0 deletions src/@ionic-native/plugins/openalpr/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
import { Injectable } from '@angular/core';
import { Plugin, Cordova, IonicNativePlugin } from '@ionic-native/core';

export interface OpenALPROptions {
/** Country used for scanning the license plate */
country?: string;

/** Amount of results returned */
amount?: number;
}

export interface OpenALPRResult {
/** LicensePlate */
number: string;
/** Probability */
confidence: number;
}

/**
* @name OpenALPR
* @description
* This Cordova plugin adds support for the OpenALPR (Automatic License Plate Recognition) library, which provides support for retrieving the license plate from a picture.
*
* @usage
* ```typescript
* import { OpenALPR, OpenALPROptions, OpenALPRResult } from '@ionic-native/openalpr';
*
*
* constructor(private openALPR: OpenALPR) { }
*
* const scanOptions: OpenALPROptions = {
* country: this.openALPR.Country.EU,
* amount: 3
* }
*
* this.openALPR.scan(imageData, scanOptions)
* .then((res: [OpenALPRResult]) => console.log(res))
* .catch((error: Error) => console.error(error));
*
* ```
*/
@Plugin({
pluginName: 'OpenALPR',
plugin: 'cordova-plugin-openalpr',
pluginRef: 'cordova.plugins.OpenALPR',
repo: 'https://github.com/iMicknl/cordova-plugin-openalpr',
platforms: ['Android', 'iOS']
})

@Injectable()
export class OpenALPR extends IonicNativePlugin {

Country = {
EU: 'eu',
US: 'us',
AU: 'au',
BR: 'br',
KR2: 'kr2'
};

/**
* This function does something
* @param imageData {any} Base64 encoding of the image data or the image file URI
* @param options {OpenALPROptions} Options to pass to the OpenALPR scanner
* @return {Promise<any>} Returns a promise that resolves when something happens
*/
@Cordova()
scan(imageData: any, options?: OpenALPROptions): Promise<any> { return; }
}

0 comments on commit e27fbf4

Please sign in to comment.