Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
c0shea committed Aug 11, 2017
1 parent c04655a commit 59bd94c
Showing 1 changed file with 32 additions and 6 deletions.
38 changes: 32 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
# ID Parser

ID Parser can be used to parse AAMVA-compliant driver's licenses and ID cards into objects that you can work with. [More information on the versions of the AAMVA standard.](http://www.aamva.org/DL-ID-Card-Design-Standard/)
![Build Status](https://coshea.visualstudio.com/_apis/public/build/definitions/51c35e17-5e8a-4b8a-8c23-dabefcc52c57/5/badge)

ID Parser can be used to parse AAMVA-compliant driver's licenses and ID cards into objects that you can
work with. [More information on the versions of the AAMVA standard.](http://www.aamva.org/DL-ID-Card-Design-Standard/)

## Usage

1. Include the using
```cs
using IdParser;
```

2. Then you're off to the races!

```cs
var idCard = IdParser.Parse(barcode);
var idCard = Barcode.Parse(barcode);
Console.WriteLine(idCard.StreetLine1); // "123 NORTH STATE ST."
Console.WriteLine(idCard.IssuerIdentificationNumber.GetDescription()); // "New York"
Expand All @@ -21,12 +31,28 @@ Take a look at the unit test project for more examples and usage.

## Client

The ```IdParser.Client``` project is a handy GUI application to help test and verify that an ID will be parsed correctly. The app works with both OPOS and HID keyboard emulation scanners.
The ```IdParser.Client``` project is a handy GUI application to help test and verify that an ID
will be parsed correctly. The app works with both OPOS and HID keyboard emulation scanners.

![](https://raw.githubusercontent.com/c0shea/IdParser/master/IdParser.Client.png)

## FAQ

* **I can't build ```IdParser.Client```. It's missing a required dependency.** You need to have [Microsoft POS for .NET](https://www.microsoft.com/en-us/download/details.aspx?id=5355) installed. The ```Microsoft.PointOfService``` dll is GAC'd and will allow you to build and run the client app. If you have POS for .NET version 1.12 installed, only the .NET 2.0 and 3.5 versions of the client will work with OPOS. You can still use the HID keyboard emulation in any .NET version of the client.

* **The ```Height``` class has the wrong ```TotalInches``` or ```Centimeters```.** The AAMVA standard has no decimal places in the height subfile record. As a result, the conversion between inches and centimeters will be off.
* **I can't build ```IdParser.Client```. It's missing a required dependency.**
You need to have [Microsoft POS for .NET](https://www.microsoft.com/en-us/download/details.aspx?id=5355)
installed. The ```Microsoft.PointOfService``` dll is GAC'd and will allow you to build and run
the client app. If you have POS for .NET version 1.12 installed, only the .NET 2.0 and 3.5 versions of
the client will work with OPOS. You can still use the HID keyboard emulation in any .NET version of
the client.

* **The ```Height``` class has the wrong ```TotalInches``` or ```Centimeters```.**
The AAMVA standard has no decimal places in the height subfile record.
As a result, the conversion between inches and centimeters will be off.

* **The library is throwing `ArgumentExcpetions` for every barcode I'm passing in.**
By default, all barcodes are parsed using the `Strict` validation level. All barcodes are expected to
adhere exactly to the AAMVA standard as defined in the PDFs for parsing to succeed. This is the
recommended level for scanners using OPOS. However, if HID keyboard emulation is used, especially when
scanning using a web browser, the expected data can become malformed. You can try using the `None`
validation level, however this is not guaranteed to work in all cases. Data elements may be skipped
and exceptions may still be thrown.

0 comments on commit 59bd94c

Please sign in to comment.