react-native-honeywell-scanner-dolphin

React Native Honeywell Scanner With Soft Trigger

This package is build using the reference. Implementation also borrows concepts from This fork.

This package works with Honeywell devices that have an integrated barcode scanner, like the Honeywell Dolphin CT60. This package was fully tested with a CT60, since the SDK is not specific to the CT60 other devices will likely work as well but this is not guaranteed.

Tip: Use react-native-camera as fallback for devices that don't have an integrated scanner; it has an integrated barcode scanner by using the camera.

Installation

npm install react-native-honeywell-scanner-dolphin

(Or)

yarn add react-native-honeywell-scanner-dolphin

To install the native dependencies:

react-native link react-native-honeywell-scanner-dolphin

Usage

First you'll want to check whether the device is a Honeywell scanner:

import HoneywellScanner from 'react-native-honeywell-scanner-dolphin';

HoneywellScanner.isCompatible // true or false

The barcode reader needs to be "claimed" by your application; meanwhile no other application can use it. You can do that like this:

useEffect(() => {
    if (isCompatible) {
      HoneywellScanner.startReader().then(claimed => {
        console.log(
          deviceClaimed
            ? 'Barcode reader is claimed'
            : 'Barcode reader is busy',
        );
        HoneywellScanner.onBarcodeReadSuccess(event => {
	  console.log('Barcode Scan data', event.data);
    	  console.log('Barcode Scan Timestamp', event.timeStamp);
    	  console.log('Barcode Scan Type', event.symbology);
        });

        HoneywellScanner.onBarcodeReadFail(event => {
          console.log('Barcode read failed');
        });
      });

      return () => {
        HoneywellScanner.stopReader().then(() => {
          console.log('Stop Reader!!');
          HoneywellScanner.offBarcodeReadSuccess();
          HoneywellScanner.offBarcodeReadFail();
        });
      };
    }
  }, [isCompatible]);

To free the claim and stop the reader, also freeing up resources:

HoneywellScanner.stopReader().then(() => {
    console.log('Freedom!');
});

To get events from the barcode scanner:

HoneywellScanner.onBarcodeReadSuccess(event => {
    console.log('Barcode Scan data', event.data);
    console.log('Barcode Scan Timestamp', event.timeStamp);
    console.log('Barcode Scan Type', event.symbology);
});

HoneywellScanner.onBarcodeReadFail(event => {
    console.log('Barcode read failed');
});

To stop receiving events:

HoneywellScanner.offBarcodeReadSuccess();
HoneywellScanner.offBarcodeReadFail();

Soft Trigger

Below logic would ensure you have soft trigger handling. This will toggle the scan button in your application

HoneywellScanner.softwareTriggerStart((error, name) => {
      setApiErrorMessage(error != null ? error : name);
});
setTimeout(() => {
      HoneywellScanner.softwareTriggerStop((error, name) => {
        setApiErrorMessage(error != null ? error : name);
      });
}, 2000);

Inspiration

The react-native-bluetooth-serial project was used as inspiration. cordova-honeywell also served as some inspiration.