Capacitor DataWedge - community maintained plugin

This plugin allows you to simply gain access to receiving barcode data and use some api methods from the DataWedge API designed for Capacitor with Zebra devices.

capacitor-datawedge project is unofficial and completely community maintained, do not mistake this plugin with the official Zebra Scanner plugin.

It is advised to use official plugin for full compatibility and guaranteed support, this project was created before the official plugin existed and is maintained by people who use it - it does not aim for full compatibility, features are added when someone cares enough to share the changes with other people in the true open source nature.

Install

npm install capacitor-datawedge
npx cap sync

The last supported version for Capacitor v3 is [email protected]

The last supported version for Capacitor v4 is [email protected]

Usage

Enable intent output in your DataWedge profile, set Intent delivery to Broadcast intent and set Intent action to com.capacitor.datawedge.RESULT_ACTION

import { DataWedge } from 'capacitor-datawedge';

// Register scan listener to receive barcode data
DataWedge.addListener('scan', event => {
  console.log(event.data);
});

// Scanning the barcode using physical trigger should fire up your scan callback!
// Check API for more methods

API

• enable()
• disable()
• enableScanner()
• disableScanner()
• startScanning()
• stopScanning()
• registerBroadcastReceiver(...)
• sendBroadcastWithExtras(...)
• addListener('scan' | 'broadcast', ...)
• removeAllListeners()
• __registerReceiver()
• Interfaces
• Type Aliases

Every broadcasted intent assumes com.symbol.datawedge.api package as default.

Package name can be changed by modyfing DATAWEDGE_PACKAGE variable here

enable()

enable() => Promise<void>

Enables DataWedge

Broadcasts intent action with .ENABLE_DATAWEDGE extra set to true

Since: 0.0.3

disable()

disable() => Promise<void>

Disables DataWedge

Broadcasts intent action with .ENABLE_DATAWEDGE extra set to false

Since: 0.0.3

enableScanner()

enableScanner() => Promise<void>

Enables physical scanner

Broadcasts intent action with .SCANNER_INPUT_PLUGIN extra set to ENABLE_PLUGIN

Since: 0.0.3

disableScanner()

disableScanner() => Promise<void>

Disables physical scanner

Broadcasts intent action with .SCANNER_INPUT_PLUGIN extra set to DISABLE_PLUGIN

Since: 0.0.3

startScanning()

startScanning() => Promise<void>

Starts software scanning trigger

Broadcasts intent action with .SOFT_SCAN_TRIGGER extra set to START_SCANNING

Since: 0.1.2

stopScanning()

stopScanning() => Promise<void>

Stops software scanning trigger

Broadcasts intent action with .SOFT_SCAN_TRIGGER extra set to STOP_SCANNING

Since: 0.1.2

registerBroadcastReceiver(...)

registerBroadcastReceiver(filter: BroadcastReceiverFilter) => Promise<void>

Register broadcast receiver

| Param | Type | | ------------ | --------------------------------------------------------------------------- | | filter | BroadcastReceiverFilter |

Since: 0.3.0

sendBroadcastWithExtras(...)

sendBroadcastWithExtras(intent: BroadcastIntent) => Promise<void>

Send broadcast with extras

| Param | Type | | ------------ | ----------------------------------------------------------- | | intent | BroadcastIntent |

Since: 0.3.0

addListener('scan' | 'broadcast', ...)

addListener(eventName: 'scan' | 'broadcast', listenerFunc: ScanListener | BroadcastListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for successful barcode readings

Notice: Requires intent action to be set to com.capacitor.datawedge.RESULT_ACTION in current DataWedge profile (it may change in the future)

| Param | Type | | ------------------ | ----------------------------------------------------------------------------------------------------------- | | eventName | 'scan' | 'broadcast' | | listenerFunc | ScanListener | BroadcastListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 0.1.0

removeAllListeners()

removeAllListeners() => Promise<void>

Remove all listeners

Since: 0.3.0

__registerReceiver()

__registerReceiver() => Promise<void>

Internal method to register intent broadcast receiver

THIS METHOD IS FOR INTERNAL USE ONLY

Since: 0.1.3

Interfaces

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

ScanListenerEvent

| Prop | Type | Description | Since | | ---------- | --------------------------- | --------------- | ----- | | data | string | Data of barcode | 0.1.0 | | type | string | null | Type of barcode | 0.2.1 |

Type Aliases

BroadcastReceiverFilter

{ filterActions: string[]; filterCategories: string[]; }

BroadcastIntent

{ action: string; extras: JsonObject; }

JsonObject

{ [key: string]: | string | number | boolean | JsonObject | string[] | number[] | boolean[] | JsonObject[]; }

ScanListener

(state: ScanListenerEvent): void

BroadcastListener

(state: JsonObject): void

License

BSD-3-Clause

Copyright (c) 2021-2023, jkbz64 and contributors
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.

* Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.