https://github.com/jkbz64/capacitor-datawedge
Capacitor plugin for DataWedge API
https://github.com/jkbz64/capacitor-datawedge
android capacitor capacitor-plugin datawedge typescript zebra
Last synced: 4 months ago
JSON representation
Capacitor plugin for DataWedge API
- Host: GitHub
- URL: https://github.com/jkbz64/capacitor-datawedge
- Owner: jkbz64
- License: bsd-3-clause
- Created: 2021-07-14T19:31:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-02-24T22:26:24.000Z (12 months ago)
- Last Synced: 2025-08-26T04:46:06.063Z (6 months ago)
- Topics: android, capacitor, capacitor-plugin, datawedge, typescript, zebra
- Language: Java
- Homepage:
- Size: 479 KB
- Stars: 12
- Watchers: 2
- Forks: 11
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://ionic.io/docs/zebra-datawedge) 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
```bash
npm install capacitor-datawedge
npx cap sync
```
The last supported version for Capacitor v3 is `capacitor-datawedge@0.1.3`
The last supported version for Capacitor v4 is `capacitor-datawedge@0.2.1`
The last supported version for Capacitor v5 is `capacitor-datawedge@0.3.1`
The last supported version for Capacitor v6 is `capacitor-datawedge@0.3.4`
## Usage
Enable intent output in your DataWedge profile, set `Intent delivery` to `Broadcast intent` and set `Intent action` to `com.capacitor.datawedge.RESULT_ACTION`
```js
import { DataWedge } from 'capacitor-datawedge';
// Optional: in case you want to use your custom intent action instead
// DataWedge.__registerReceiver({ intent: "my.custom.action" });
// 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()`](#enable)
* [`disable()`](#disable)
* [`enableScanner()`](#enablescanner)
* [`disableScanner()`](#disablescanner)
* [`startScanning()`](#startscanning)
* [`stopScanning()`](#stopscanning)
* [`addListener('scan', ...)`](#addlistenerscan-)
* [`__registerReceiver(...)`](#__registerreceiver)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
Every broadcasted intent assumes `com.symbol.datawedge.api` package as default.
Package name can be changed by modyfing `DATAWEDGE_PACKAGE` variable [here](android/src/main/java/com/jkbz/capacitor/datawedge/DataWedge.java)
### enable()
```typescript
enable() => Promise
```
Enables DataWedge
Broadcasts intent action with `.ENABLE_DATAWEDGE` extra set to `true`
**Since:** 0.0.3
--------------------
### disable()
```typescript
disable() => Promise
```
Disables DataWedge
Broadcasts intent action with `.ENABLE_DATAWEDGE` extra set to `false`
**Since:** 0.0.3
--------------------
### enableScanner()
```typescript
enableScanner() => Promise
```
Enables physical scanner
Broadcasts intent action with `.SCANNER_INPUT_PLUGIN` extra set to `ENABLE_PLUGIN`
**Since:** 0.0.3
--------------------
### disableScanner()
```typescript
disableScanner() => Promise
```
Disables physical scanner
Broadcasts intent action with `.SCANNER_INPUT_PLUGIN` extra set to `DISABLE_PLUGIN`
**Since:** 0.0.3
--------------------
### startScanning()
```typescript
startScanning() => Promise
```
Starts software scanning trigger
Broadcasts intent action with `.SOFT_SCAN_TRIGGER` extra set to `START_SCANNING`
**Since:** 0.1.2
--------------------
### stopScanning()
```typescript
stopScanning() => Promise
```
Stops software scanning trigger
Broadcasts intent action with `.SOFT_SCAN_TRIGGER` extra set to `STOP_SCANNING`
**Since:** 0.1.2
--------------------
### addListener('scan', ...)
```typescript
addListener(eventName: 'scan', listenerFunc: ScanListener) => Promise
```
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' |
| **`listenerFunc`** | ScanListener |
**Returns:** Promise<PluginListenerHandle>
**Since:** 0.1.0
--------------------
### __registerReceiver(...)
```typescript
__registerReceiver(options?: RegisterOptions | undefined) => Promise
```
Internal method to register intent broadcast receiver
THIS METHOD IS FOR INTERNAL USE ONLY
| Param | Type |
| ------------- | ----------------------------------------------------------- |
| **`options`** | RegisterOptions |
**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
#### ScanListener
(state: ScanListenerEvent): void
#### RegisterOptions
{ /** * Intent action name to listen for * * @since 0.3.1 */ intent?: string; }
## 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.
```