@capgo/capacitor-zebra-datawedge

Scan barcodes and RFID tags on Zebra Android devices from your Capacitor app with DataWedge: manage profiles, trigger scans and receive results. An open alternative to Ionic's enterprise Zebra scanner.

🤖 Building with an AI coding agent? Install Capgo skills so Claude Code, Codex, Cursor, Copilot, or Gemini CLI know how to install and use @capgo/capacitor-zebra-datawedge in your Capacitor app: npx skills add Cap-go/capgo-skills. Then ask your agent: "Add @capgo/capacitor-zebra-datawedge to my Capacitor app and wire it up." Agent setup guides · Hosted MCP

Key features

• Scan events: the scan listener delivers barcode and RFID data.
• Soft scanning: softScanTrigger() starts a scan from your UI.
• Profiles: createProfile(), cloneProfile(), renameProfile(), deleteProfile() and setConfig().
• Queries: enumerateScanners(), getActiveProfile(), getConfig() and getDatawedgeStatus().
• Notifications: registerForNotification() with the notification event.
• Platforms: Android. Android only, on Zebra devices with DataWedge. iOS and web return not available errors.

Capgo's Zebra DataWedge plugin brings Zebra's Android barcode and RFID capture APIs to Capacitor.

It is designed as an open alternative to Ionic's enterprise Zebra Scanner offering and exposes the same high-level groups:

• ZebraConfiguration for profile management
• ZebraNotification for scanner/profile status notifications
• ZebraQuery for profile, scanner, and DataWedge queries
• ZebraRuntime for enabling/disabling scanners and triggering scans

Documentation

The complete documentation is published here: https://capgo.app/docs/plugins/zebra-datawedge/

Compatibility

This plugin is Android-only in practice because Zebra DataWedge itself runs on Zebra Android devices.

Install

You can use our AI-Assisted Setup to install the plugin. Add the Capgo skills to your AI tool using the following command:

npx skills add https://github.com/cap-go/capacitor-skills --skill capacitor-plugins

Then use the following prompt:

Use the `capacitor-plugins` skill from `cap-go/capacitor-skills` to install the `@capgo/capacitor-zebra-datawedge` plugin in my project.

If you prefer Manual Setup, install the plugin by running the following commands and follow the platform-specific instructions below:

bun add @capgo/capacitor-zebra-datawedge
bunx cap sync

Zebra setup

Configure a DataWedge profile on the Zebra device before scanning:

1. Associate the profile with your app.
2. Enable Intent Output.
3. Set Intent delivery to Broadcast Intent.
4. Choose an intent action such as app.capgo.zebra.SCAN.

Basic usage

import {
  DataWedgeConfigMode,
  DataWedgePlugin,
  ZebraConfiguration,
  ZebraDataWedge,
  ZebraRuntime,
} from '@capgo/capacitor-zebra-datawedge';

const intentAction = 'app.capgo.zebra.SCAN';

await ZebraConfiguration.setConfig({
  profileName: 'CapgoZebraProfile',
  profileEnabled: true,
  configMode: DataWedgeConfigMode.CREATE_IF_NOT_EXIST,
  appList: [
    {
      packageName: 'com.example.app',
      activityList: ['*'],
    },
  ],
  pluginConfigs: [
    {
      pluginName: DataWedgePlugin.BARCODE,
      resetConfig: true,
      paramList: {
        scanner_selection: 'auto',
        scanner_input_enabled: 'true',
      },
    },
    {
      pluginName: DataWedgePlugin.INTENT,
      resetConfig: true,
      paramList: {
        intent_output_enabled: 'true',
        intent_action: intentAction,
        intent_delivery: 2,
      },
    },
  ],
});

await ZebraDataWedge.addListener('scan', (result) => {
  console.log('Scanned', result.data, result.labelType);
});

// Physical scan button: intent action is registered automatically from setConfig above.
// You can also register explicitly before listening:
// await ZebraRuntime.registerScanIntentAction(intentAction);

const result = await ZebraRuntime.softScanTrigger(intentAction);
console.log(result);

Notes

• Query and configuration APIs depend on Zebra DataWedge being installed and enabled.
• setConfig() registers scan intent actions from scanIntentAction and from INTENT plugin intent_action values in pluginConfigs after a successful update, whether or not scanIntentAction is provided.
• registerScanIntentAction() registers a custom intent action without calling registerForNotification() or softScanTrigger(). Repeat on every app start because receiver registration is in-memory only.
• softScanTrigger() waits for the next scan broadcast on the intent action you provide.
• softRfidTrigger() uses the first registered scan intent action. Register a scan action first if you need RFID reads.
• Web and iOS return "not available" errors for all DataWedge operations.

Broadcast compatibility and security

DataWedge can return query results without COMMAND_IDENTIFIER. The plugin accepts such a result only when its payload type matches exactly one pending query that expects that payload shape. Avoid overlapping pending calls that share the same result payload shape: replies without identifiers cannot reliably distinguish their owners. For example, getAssociatedApps() and getConfig() both send CMD_GET_CONFIG and expect CONFIG_RESULTS, so one pending call to each still overlaps. If a query times out, a delayed identifier-free reply to the timed-out query can still match a later sequential call that expects the same payload shape and resolve it with stale data. Replies with unknown nonempty identifiers are not assigned to another query.

On Android 14/API 34 and later, identifier-free replies that share platform sender identity must identify the DataWedge package. A sender can withhold its identity on API 34 and later, and the plugin then accepts matching identifier-free results. Identity is also unavailable on Android API 24 to 33, where the plugin accepts matching identifier-free results for compatibility with DataWedge.

Query correlation and payload validation do not guarantee sender authenticity. Any installed app can inject a matching identifier-free query result on every Android version, including by withholding its identity on API 34 and later. Replies with matching command identifiers, scan data and notification broadcasts also lack complete sender authentication. See the known sender-authentication limitations for details.

API

• cloneProfile(...)
• createProfile(...)
• deleteProfile(...)
• importConfig(...)
• renameProfile(...)
• restoreConfig()
• setConfig(...)
• setDisabledAppList(...)
• setIgnoreDisabledProfiles(...)
• registerForNotification(...)
• registerScanIntentAction(...)
• unRegisterForNotification(...)
• enumerateScanners()
• getActiveProfile()
• getAssociatedApps(...)
• getConfig(...)
• getDatawedgeStatus()
• getDisabledAppList()
• getIgnoreDisabledProfiles()
• getProfilesList()
• getScannerStatus()
• getVersionInfo()
• disableDatawedge()
• disableScannerInput()
• enableDatawedge()
• enableScannerInput()
• enumerateTriggers()
• notify(...)
• resetDefaultProfile()
• setDefaultProfile(...)
• setReportingOptions(...)
• softRfidTrigger()
• softScanTrigger(...)
• switchScanner(...)
• switchScannerParams(...)
• switchToProfile(...)
• getPluginVersion()
• addListener('scan', ...)
• addListener('notification', ...)
• Interfaces
• Type Aliases
• Enums

cloneProfile(...)

cloneProfile(options: CloneProfileOptions) => Promise<void>

createProfile(...)

createProfile(options: CreateProfileOptions) => Promise<void>

deleteProfile(...)

deleteProfile(options: DeleteProfileOptions) => Promise<void>

importConfig(...)

importConfig(options: ImportConfigOptions) => Promise<void>

renameProfile(...)

renameProfile(options: RenameProfileOptions) => Promise<void>

restoreConfig()

restoreConfig() => Promise<void>

setConfig(...)

setConfig(options: SetConfigOptions) => Promise<void>

setDisabledAppList(...)

setDisabledAppList(options: SetDisabledAppListOptions) => Promise<void>

setIgnoreDisabledProfiles(...)

setIgnoreDisabledProfiles(options: IgnoreDisabledProfilesResult) => Promise<void>

registerForNotification(...)

registerForNotification(options: Omit<RegisterForNotificationOptions, 'callback'>) => Promise<void>

Completes when the notification command is dispatched to DataWedge. This does not confirm registration, policy approval, or scanner readiness; observe notification events to determine the scanner's state.

registerScanIntentAction(...)

registerScanIntentAction(options: RegisterScanIntentActionOptions) => Promise<void>

Registers a DataWedge scan broadcast intent action in the Android plugin receiver (runtime only; call again on every app start). Use when your profile uses a custom intent_action and scans come from the physical trigger.

unRegisterForNotification(...)

unRegisterForNotification(options: Omit<RegisterForNotificationOptions, 'callback'>) => Promise<void>

Completes when the unregistration command is dispatched to DataWedge. This does not confirm unregistration or policy approval; notifications may already be queued. Dispose of local listeners separately when using the low-level API.

enumerateScanners()

enumerateScanners() => Promise<{ scanners: ZebraDeviceScanner[]; }>

Android only. DataWedge may omit COMMAND_IDENTIFIER on query replies. The plugin accepts identifier-free replies only when the payload matches exactly one pending call that expects the same result payload shape. Avoid overlapping pending calls that share that shape. When sender identity is unavailable (Android API 24 to 33, or API 34+ when the platform withholds it), matching identifier-free replies are accepted for compatibility. If a call times out, a delayed identifier-free reply can still match a later sequential call that expects the same shape and resolve it with stale data. This default may change in the next Capacitor major version; see https://github.com/Cap-go/capacitor-zebra-datawedge/issues/25/.

Returns: Promise<{ scanners: ZebraDeviceScanner[]; }>

getActiveProfile()

getActiveProfile() => Promise<{ profileName: string; }>

Android only. DataWedge may omit COMMAND_IDENTIFIER on query replies. The plugin accepts identifier-free replies only when the payload matches exactly one pending call that expects the same result payload shape. Avoid overlapping pending calls that share that shape. When sender identity is unavailable (Android API 24 to 33, or API 34+ when the platform withholds it), matching identifier-free replies are accepted for compatibility. If a call times out, a delayed identifier-free reply can still match a later sequential call that expects the same shape and resolve it with stale data. This default may change in the next Capacitor major version; see https://github.com/Cap-go/capacitor-zebra-datawedge/issues/25/.

Returns: Promise<{ profileName: string; }>

getAssociatedApps(...)

getAssociatedApps(options: { profileName: string; }) => Promise<{ appList: DataWedgeAppConfig[]; }>

Android only. DataWedge may omit COMMAND_IDENTIFIER on query replies. The plugin accepts identifier-free replies only when the payload matches exactly one pending call that expects the same result payload shape. Avoid overlapping pending calls that share that shape. For example, getAssociatedApps() and getConfig() both send CMD_GET_CONFIG and expect CONFIG_RESULTS, so one pending call to each overlaps. When sender identity is unavailable (Android API 24 to 33, or API 34+ when the platform withholds it), matching identifier-free replies are accepted for compatibility. If a call times out, a delayed identifier-free reply can still match a later sequential call that expects the same shape and resolve it with stale data. This default may change in the next Capacitor major version; see https://github.com/Cap-go/capacitor-zebra-datawedge/issues/25/.

Returns: Promise<{ appList: DataWedgeAppConfig[]; }>

getConfig(...)

getConfig(options: GetConfigOptions) => Promise<ZebraProfileConfiguration>

Android only. DataWedge may omit COMMAND_IDENTIFIER on query replies. The plugin accepts identifier-free replies only when the payload matches exactly one pending call that expects the same result payload shape. Avoid overlapping pending calls that share that shape. For example, getAssociatedApps() and getConfig() both send CMD_GET_CONFIG and expect CONFIG_RESULTS, so one pending call to each overlaps. When sender identity is unavailable (Android API 24 to 33, or API 34+ when the platform withholds it), matching identifier-free replies are accepted for compatibility. If a call times out, a delayed identifier-free reply can still match a later sequential call that expects the same shape and resolve it with stale data. This default may change in the next Capacitor major version; see https://github.com/Cap-go/capacitor-zebra-datawedge/issues/25/.

Returns: Promise<ZebraProfileConfiguration>

getDatawedgeStatus()

getDatawedgeStatus() => Promise<DataWedgeStatusResult>

Android only. DataWedge may omit COMMAND_IDENTIFIER on query replies. The plugin accepts identifier-free replies only when the payload matches exactly one pending call that expects the same result payload shape. Avoid overlapping pending calls that share that shape. When sender identity is unavailable (Android API 24 to 33, or API 34+ when the platform withholds it), matching identifier-free replies are accepted for compatibility. If a call times out, a delayed identifier-free reply can still match a later sequential call that expects the same shape and resolve it with stale data. This default may change in the next Capacitor major version; see https://github.com/Cap-go/capacitor-zebra-datawedge/issues/25/.

Returns: Promise<DataWedgeStatusResult>

getDisabledAppList()

getDisabledAppList() => Promise<{ appList: DataWedgeAppConfig[]; }>

Android only. DataWedge may omit COMMAND_IDENTIFIER on query replies. The plugin accepts identifier-free replies only when the payload matches exactly one pending call that expects the same result payload shape. Avoid overlapping pending calls that share that shape. When sender identity is unavailable (Android API 24 to 33, or API 34+ when the platform withholds it), matching identifier-free replies are accepted for compatibility. If a call times out, a delayed identifier-free reply can still match a later sequential call that expects the same shape and resolve it with stale data. This default may change in the next Capacitor major version; see https://github.com/Cap-go/capacitor-zebra-datawedge/issues/25/.

Returns: Promise<{ appList: DataWedgeAppConfig[]; }>

getIgnoreDisabledProfiles()

getIgnoreDisabledProfiles() => Promise<IgnoreDisabledProfilesResult>

Android only. DataWedge may omit COMMAND_IDENTIFIER on query replies. The plugin accepts identifier-free replies only when the payload matches exactly one pending call that expects the same result payload shape. Avoid overlapping pending calls that share that shape. When sender identity is unavailable (Android API 24 to 33, or API 34+ when the platform withholds it), matching identifier-free replies are accepted for compatibility. If a call times out, a delayed identifier-free reply can still match a later sequential call that expects the same shape and resolve it with stale data. This default may change in the next Capacitor major version; see https://github.com/Cap-go/capacitor-zebra-datawedge/issues/25/.

Returns: Promise<IgnoreDisabledProfilesResult>

getProfilesList()

getProfilesList() => Promise<{ profiles: string[]; }>

Android only. DataWedge may omit COMMAND_IDENTIFIER on query replies. The plugin accepts identifier-free replies only when the payload matches exactly one pending call that expects the same result payload shape. Avoid overlapping pending calls that share that shape. When sender identity is unavailable (Android API 24 to 33, or API 34+ when the platform withholds it), matching identifier-free replies are accepted for compatibility. If a call times out, a delayed identifier-free reply can still match a later sequential call that expects the same shape and resolve it with stale data. This default may change in the next Capacitor major version; see https://github.com/Cap-go/capacitor-zebra-datawedge/issues/25/.

Returns: Promise<{ profiles: string[]; }>

getScannerStatus()

getScannerStatus() => Promise<{ status: ScannerStatus | string; }>

Android only. DataWedge may omit COMMAND_IDENTIFIER on query replies. The plugin accepts identifier-free replies only when the payload matches exactly one pending call that expects the same result payload shape. Avoid overlapping pending calls that share that shape. When sender identity is unavailable (Android API 24 to 33, or API 34+ when the platform withholds it), matching identifier-free replies are accepted for compatibility. If a call times out, a delayed identifier-free reply can still match a later sequential call that expects the same shape and resolve it with stale data. This default may change in the next Capacitor major version; see https://github.com/Cap-go/capacitor-zebra-datawedge/issues/25/.

Returns: Promise<{ status: string; }>

getVersionInfo()

getVersionInfo() => Promise<ZebraDeviceVersionInfo>

Android only. DataWedge may omit COMMAND_IDENTIFIER on query replies. The plugin accepts identifier-free replies only when the payload matches exactly one pending call that expects the same result payload shape. Avoid overlapping pending calls that share that shape. When sender identity is unavailable (Android API 24 to 33, or API 34+ when the platform withholds it), matching identifier-free replies are accepted for compatibility. If a call times out, a delayed identifier-free reply can still match a later sequential call that expects the same shape and resolve it with stale data. This default may change in the next Capacitor major version; see https://github.com/Cap-go/capacitor-zebra-datawedge/issues/25/.

Returns: Promise<ZebraDeviceVersionInfo>

disableDatawedge()

disableDatawedge() => Promise<void>

disableScannerInput()

disableScannerInput() => Promise<void>

enableDatawedge()

enableDatawedge() => Promise<void>

enableScannerInput()

enableScannerInput() => Promise<void>

enumerateTriggers()

enumerateTriggers() => Promise<{ triggers: string[]; }>

Android only. DataWedge may omit COMMAND_IDENTIFIER on query replies. The plugin accepts identifier-free replies only when the payload matches exactly one pending call that expects the same result payload shape. Avoid overlapping pending calls that share that shape. When sender identity is unavailable (Android API 24 to 33, or API 34+ when the platform withholds it), matching identifier-free replies are accepted for compatibility. If a call times out, a delayed identifier-free reply can still match a later sequential call that expects the same shape and resolve it with stale data. This default may change in the next Capacitor major version; see https://github.com/Cap-go/capacitor-zebra-datawedge/issues/25/.

Returns: Promise<{ triggers: string[]; }>

notify(...)

notify(options: DataWedgeNotifyOptions) => Promise<void>

resetDefaultProfile()

resetDefaultProfile() => Promise<void>

setDefaultProfile(...)

setDefaultProfile(options: { profileName: string; }) => Promise<void>

setReportingOptions(...)

setReportingOptions(options: ReportingOptions) => Promise<void>

softRfidTrigger()

softRfidTrigger() => Promise<ZebraScanResult>

Returns: Promise<ZebraScanResult>

softScanTrigger(...)

softScanTrigger(options: { intentAction: string; }) => Promise<ZebraScanResult>

Returns: Promise<ZebraScanResult>

switchScanner(...)

switchScanner(options: { scannerIndex?: string; scannerIdentifier?: ScannerIdentifier; }) => Promise<void>

switchScannerParams(...)

switchScannerParams(options: SwitchScannerParamsOptions) => Promise<void>

switchToProfile(...)

switchToProfile(options: { profileName: string; }) => Promise<void>

getPluginVersion()

getPluginVersion() => Promise<PluginVersionResult>

Returns: Promise<PluginVersionResult>

addListener('scan', ...)

addListener(eventName: 'scan', listenerFunc: (event: ZebraScanResult) => void) => Promise<PluginListenerHandle>

Returns: Promise<PluginListenerHandle>

addListener('notification', ...)

addListener(eventName: 'notification', listenerFunc: (event: ZebraNotificationEvent) => void) => Promise<PluginListenerHandle>

Returns: Promise<PluginListenerHandle>

Interfaces

CloneProfileOptions

CreateProfileOptions

DeleteProfileOptions

ImportConfigOptions

RenameProfileOptions

SetConfigOptions

DataWedgeAppConfig

DataWedgePluginConfig

DataWedgePluginParameters

SetDisabledAppListOptions

IgnoreDisabledProfilesResult

RegisterForNotificationOptions

ZebraNotificationEvent

RegisterScanIntentActionOptions

ZebraDeviceScanner

ZebraProfileConfiguration

GetConfigOptions

PluginConfigOptions

DataWedgeStatusResult

ZebraDeviceVersionInfo

DataWedgeNotifyOptions

ReportingOptions

ZebraScanResult

SwitchScannerParamsOptions

PluginVersionResult

PluginListenerHandle

Type Aliases

Omit

Construct a type with the properties of T except for those in type K.

Pick

From T, pick a set of properties whose keys are in the union K

{ [P in K]: T[P]; }

Exclude

Exclude from T those types that are assignable to U

T extends U ? never : T

Record

Construct a type with a set of properties K of type T

{ [P in K]: T; }

Enums

DataWedgeConfigMode

DataWedgePlugin

ScannerStatus

DataWedgeNotificationType

ScannerIdentifier