Skip to content

Commit

Permalink
Merge pull request #48 from zxing-js/develop
Browse files Browse the repository at this point in the history 
Release v0.5.1
  • Loading branch information
@odahcam
odahcam authored Jun 5, 2018
2 parents 72cf338 + 4bf53b5 commit b037218
Show file tree
Hide file tree
Showing 3 changed files with 6,187 additions and 91 deletions.
143 changes: 57 additions & 86 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# ZXing

### Runs on your favorite JavaScript ecosystem
### Runs on your favorite ECMAScript ecosystem

> If it doesn't, we gonna make it.
Expand All @@ -12,7 +12,7 @@
## Supported Formats

**_WIP_**: see [Projects](/zxing-js/library/projects) and [Milestones](/zxing-js/library/milestones) for what is currently done and what's planned next. 👀
> See [Projects](https://github.com/zxing-js/library/projects) and [Milestones](https://github.com/zxing-js/library/milestones) for what is currently done and what's planned next. 👀
| 1D product | 1D industrial | 2D
| ---------------------- | -------------------- | --------------
Expand All @@ -38,55 +38,55 @@

## Demo

See [some demo examples](https://zxing-js.github.io/library/) in browser.
See [Live Preview](https://zxing-js.github.io/library/) in browser.

**Note:** All the examples are using ES6, be sure is supported in your browser or modify as needed, Chrome recomended.

## Usage

The library can be used from browser with TypeScript (include anything from src/browser however you must do the packaging yourself) or with plain javascript (see below). It can also be used from node (see also below). The library is using separate builds for node and browser to allow different ES targeting.
### Instalation

### Environments
`npm i @zxing/library --save`

#### Browser
or

`yarn add @zxing/library`

### Environments

Examples below are for QR barcode, all other supported barcodes work similary.

`npm i @zxing/library --save`
#### Browser

To use from JS you need to include what you need from `build/umd` folder (for example `zxing.min.js`).

See [some demo examples](https://github.com/odahcam/zxing-ts/tree/master/docs/examples) for browser code examples with javascript.

All the examples are using ES6, be sure is supported in your browser or modify as needed (eg. var instead of const etc.).
##### Browser Support

The browser library is using the [MediaDevices](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices) web api which is marked as experimental as of this writing. You can use external polyfills like [webrtc-adapter](https://github.com/webrtc/adapter) to increase browser compatiblity.
The browser layer is using the [MediaDevices](https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices) web API which is not supported by older browsers.

Also, note that the library is using the [TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) (Int32Array, Uint8ClampedArray, etc.) which are not available in older browsers (for example Android 4 default browser, etc.). You can use a polyfill library like [core-js](https://github.com/zloirock/core-js) to support these browsers.
_You can use external polyfills like [WebRTC adapter](https://github.com/webrtc/adapter) to increase browser compatiblity._

#### TypeScript
Also, note that the library is using the [`TypedArray`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray) (`Int32Array`, `Uint8ClampedArray`, etc.) which are not available in older browsers (e.g. Android 4 default browser).

Install the package:
_You can use [core-js](https://github.com/zloirock/core-js) to add support to these browsers._

`npm i @zxing/library --save`
#### TypeScript

And then include directly the classes files you need, for example:
You can include directly the classes you need, for example:

```javascript
```typescript
import { BrowserQRCodeReader, VideoInputDevice } from '@zxing/library';
```

The usage is identical with the above.

#### Node

`npm i @zxing/library --save`

To use in node you will need to provide an implementation of [`LuminanceSource`](https://github.com/odahcam/zxing-ts/blob/master/src/core/LuminanceSource.ts) for an image. A starting point is [`SharpImageLuminanceSource`](https://github.com/odahcam/zxing-ts/blob/master/src/test/core/SharpImageLuminanceSource.ts) from tests that is using [sharp image processing](https://github.com/lovell/sharp) node library.
To use in node you will need to provide an implementation of [`LuminanceSource`](https://github.com/zxing-js/library/blob/master/src/core/LuminanceSource.ts) for an image. A starting point is [`SharpImageLuminanceSource`](https://github.com/zxing-js/library/blob/master/src/test/core/SharpImageLuminanceSource.ts) from tests that is using [sharp image processing](https://github.com/lovell/sharp) Node library.

No examples are availabe for now, however you can have a look at the extensive [tests cases](https://github.com/odahcam/zxing-ts/tree/master/src/test/core/qrcode).
No examples are availabe for now, however you can have a look at the extensive [tests cases](https://github.com/zxing-js/library/tree/master/src/test/core/qrcode).

### Scanning from Video Camera

To display the input from the video camera you will need to add a video element in the html page:
To display the input from the video camera you will need to add a video element in the HTML page:

```html
<video id="video" width="300" height="200" style="border: 1px solid gray"></video>
Expand All @@ -98,13 +98,12 @@ To start decoding, first obtain a list of video input devices with:
const codeReader = new ZXing.BrowserQRCodeReader();

codeReader.getVideoInputDevices()
.then((videoInputDevices) => {
videoInputDevices.forEach((element) => {
console.log(`${element.label}, ${element.deviceId}`);
});
.catch((err) => {
console.error(err);
});
.then(videoInputDevices => {
videoInputDevices.forEach(
device => console.log(`${device.label}, ${device.deviceId}`)
);
})
.catch(err => console.error(err));
```

If there is just one input device you can use the first deviceId and the video element id (in the example below is also 'video') to decode:
Expand All @@ -113,11 +112,8 @@ If there is just one input device you can use the first deviceId and the video e
const firstDeviceId = videoInputDevices[0].deviceId;

codeReader.decodeFromInputVideoDevice(firstDeviceId, 'video')
.then((result) => {
console.log(result.text);
}).catch((err) => {
console.error(err);
});
.then(result => console.log(result.text))
.catch(err => console.error(err));
```

If there are more input devices then you will need to chose one for `codeReader.decodeFromInputVideoDevice` device id parameter.
Expand All @@ -126,17 +122,13 @@ You can also provide `undefined` for the device id parameter in which case the l

```javascript
codeReader.decodeFromInputVideoDevice(undefined, 'video')
.then((result) => {
console.log(result.text);
}).catch((err) => {
console.error(err);
});
.then(result => console.log(result.text))
.catch(err => console.error(err));
```

A full working example for [QR Code from Video Camera](https://github.com/odahcam/zxing-ts/tree/master/docs/examples/qr-camera/) is provided in the [examples](https://github.com/odahcam/zxing-ts/tree/master/docs/examples/).
### Scanning from Video File
Similar as above you can use a video element in the html page:

Similar as above you can use a video element in the HTML page:

```html
<video id="video" width="300" height="200" style="border: 1px solid gray"></video>
Expand All @@ -149,29 +141,21 @@ const codeReader = new ZXing.BrowserQRCodeReader();
const videoSrc = 'your url to a video';

codeReader.decodeFromVideoSource(videoSrc, 'video')
.then((result) => {
console.log(result.text);
}).catch((err) => {
console.error(err);
});
.then(result => console.log(result.text))
.catch(err => console.error(err));
```

You can also decode the video url without showing it in the page, in this case no `video` element is needed in html.
You can also decode the video url without showing it in the page, in this case no `video` element is needed in HTML.

```javascript
codeReader.decodeFromVideoSource(videoSrc)
.then((result) => {
console.log(result.text);
}).catch((err) => {
console.error(err);
});
.then(result => console.log(result.text))
.catch(err => console.error(err));
```

A full working example for [QR Code from Video File](https://github.com/odahcam/zxing-ts/tree/master/docs/examples/qr-video/) is provided in the [examples](https://github.com/odahcam/zxing-ts/tree/master/docs/examples/).
### Scanning from Image
Similar as above you can use a img element in the html page (with src attribute set):

Similar as above you can use a img element in the HTML page (with src attribute set):

```html
<img id="img" src="qrcode-image.png" width="200" height="300" style="border: 1px solid gray"></img>
Expand All @@ -184,24 +168,18 @@ const codeReader = new ZXing.BrowserQRCodeReader();
const img = document.getElementById('img');

codeReader.decodeFromImage(img)
.then((result) => {
console.log(result.text);
}).catch((err) => {
console.error(err);
});
.then(result => console.log(result.text))
.catch(err => console.error(err));
```

You can also decode the image url without showing it in the page, in this case no `img` element is needed in html:
You can also decode the image url without showing it in the page, in this case no `img` element is needed in HTML:

```javascript
const imgSrc = 'url to image';

codeReader.decodeFromImage(undefined, imgSrc)
.then((result) => {
console.log(result.text);
}).catch((err) => {
console.error(err);
});
.then(result => console.log(result.text))
.catch(err => console.error(err));
```

Or decode the image url directly from an url, with an `img` element in page (notice no `src` attribute is set for `img` element):
Expand All @@ -212,17 +190,13 @@ Or decode the image url directly from an url, with an `img` element in page (not

```javascript
const imgSrc = 'url to image';
const imgDomId = 'img-to-decode';

codeReader.decodeFromImage('img', imgSrc); // here img is the image id from html, in our case 'img'
.then((result) => {
console.log(result.text);
}).catch((err) => {
console.error(err);
});
codeReader.decodeFromImage(imgDomId, imgSrc)
.then(result => console.log(result.text))
.catch(err => console.error(err));
```

A full working example for [QR Code from Image](https://github.com/odahcam/zxing-ts/tree/master/docs/examples/qr-image/) is provided in the [examples](https://github.com/odahcam/zxing-ts/tree/master/docs/examples/).
### Barcode generation

To generate a QR Code SVG image include 'zxing.qrcodewriter.min.js' from `build/vanillajs`. You will need to include an element where the SVG element will be appended:
Expand All @@ -235,27 +209,24 @@ And then:

```javascript
const codeWriter = new ZXing.BrowserQRCodeSvgWriter('result');
var svgElement = codeWriter.write(input, 300, 300);
const svgElement = codeWriter.write(input, 300, 300);
```

A full working example for [QR Code write to SVG](https://github.com/odahcam/zxing-ts/tree/master/docs/examples/qr-svg-writer/) is provided in the [examples](https://github.com/odahcam/zxing-ts/tree/master/docs/examples/).
### Text Encoding and Decoding

To decode a barcode, the library needs at some point to decode from bits to text. Also, to generate a barcode it needs to encode text to bits. Unfortunately, the state of encoding and decoding text in javascript/browser is somehow messy at the moment.
To decode a barcode, the library needs at some point to decode from bits to text. Also, to generate a barcode it needs to encode text to bits. Unfortunately, the state of encoding and decoding text in ECMAScript/browser is somehow messy at the moment.

To have full support for all encodings in [CharacterSetECI](https://github.com/odahcam/zxing-ts/blob/master/src/core/common/CharacterSetECI.ts) *except Cp437* use [text-encoding](https://github.com/inexorabletash/text-encoding) library. The library is used implicitly for node (and tests), but is an optional dependency for browser because is rather large (> 600k). You will need to include it yourself if you want/need to use it.
To have full support for all encodings in [CharacterSetECI](https://github.com/zxing-js/library/blob/master/src/core/common/CharacterSetECI.ts) *except Cp437* use [text-encoding](https://github.com/inexorabletash/text-encoding) library. The library is used implicitly for node (and tests), but is an optional dependency for browser because is rather large (> 600k). You will need to include it yourself if you want/need to use it. The `text-encoding` library will be removed as soon as this library starts to run on TypeScript 2.8.

By default, in browser, [TextDecoder](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder)/[TextEncoder](https://developer.mozilla.org/ro/docs/Web/API/TextEncoder) web api are used if available (take care as these are labeled as experimental as of this writing). Also, be aware that TextEncoder encodes only to UTF-8 as per spec. If these are not available the library falls back to a minimal implementation that only encodes and decodes to/from UTF-8 (see [`StringEncoding`](https://github.com/odahcam/zxing-ts/blob/master/src/core/util/StringEncoding.ts)).
By default, in browser, [TextDecoder](https://developer.mozilla.org/en-US/docs/Web/API/TextDecoder)/[TextEncoder](https://developer.mozilla.org/ro/docs/Web/API/TextEncoder) web API are used if available (take care as these are labeled as experimental as of this writing). Also, be aware that TextEncoder encodes only to UTF-8 as per spec. If these are not available the library falls back to a minimal implementation that only encodes and decodes to/from UTF-8 (see [`StringEncoding`](https://github.com/zxing-js/library/blob/master/src/core/util/StringEncoding.ts)).

### Porting Information

See [TypeScript Port Info](typescriptport.md) for information regarding porting approach and reasoning behind some of the approaches taken.
See [Contributing Guide](https://github.com/zxing-js/library/blob/master/CONTRIBUTING.md) for information regarding porting approach and reasoning behind some of the approaches taken.

---

[![Bless](https://cdn.rawgit.com/LunaGao/BlessYourCodeTag/master/tags/alpaca.svg)](http://lunagao.github.io/BlessYourCodeTag/)

[0]: https://www.npmjs.com/package/@zxing/library
[1]: https://github.com/zxing/zxing
8 changes: 3 additions & 5 deletions package.json
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@zxing/library",
"version": "0.5.0",
"version": "0.5.1",
"description": "TypeScript port of ZXing multi-format 1D/2D barcode image processing library, with Code128 and ITF support.",
"keywords": [
"reader",
Expand All @@ -11,11 +11,9 @@
"generator",
"barcode",
"qr-code",
"code-128",
"ITF",
"i2of5",
"barcode 1d",
"barcode 2d",
"typescript",
"zxing-typescript",
"zxing"
],
"authors": [
Expand Down
Loading

0 comments on commit b037218

Please sign in to comment.