DataWedge API は Android インテントを介して動作し、他のアプリケーションが DataWedge UI や基盤となるハードウェアに直接アクセスすることなく、データ キャプチャを制御し、DataWedge のプロファイルや設定を管理できるようにする個別のコマンドとして機能します。インテントは、アクション インテント内のエクストラとして実装されているため、1 つのインテント アクションで複数の API 呼び出しを送信できます。
開発者向けの主なリソース:
注: Android 14以降では、Android 14 の変更により、DataWedge に送信されたインテントの受信に約 500 ミリ秒の遅延が発生します。インテントをより迅速に配信するには、sendOrderedBroadcast() の代わりにsendBroadcast() API を使用してください。
デバイスの再起動直後など、DataWedge の準備が完了する前にインテントを送信すると、処理されない場合があります。これを回避するため、Zebra では、DataWedge の準備完了を示す応答を受信するまで、Get DataWedge Status API を使用して DataWedge のステータスをポーリングすることを推奨しています。
DataWedge API は、次の 4 つのタイプに分類されます。
構成 API:
プロファイルの複製 - すべての設定を含む既存の DataWedge プロファイルのコピーを作成します。
プロファイルの作成 - 構成を設定せずに新しいプロファイルを作成します。
プロファイルの削除 - 既存のプロファイルを削除します。
構成のエクスポート - プロファイルまたは構成ファイル、あるいはその両方をエクスポートします。構成ファイルには、複数のプロファイルを含めることができます。
構成のインポート - プロファイルまたは構成ファイル、あるいはその両方をインポートします。構成ファイルには、複数のプロファイルを含めることができます。
プロファイルの名前変更 - 既存のプロファイルの名前を変更します。
構成の復元 - ユーザーが構成したすべての設定をリセットし、DataWedge を出荷時のデフォルト設定に復元します。
構成の設定 - プロファイルとその設定を作成、更新、または置換します。
無効アプリ リストの設定 - DataWedge の使用を禁止するアプリ/アクティビティをリストに対して追加、削除、または更新します。
無効なプロファイルを無視の設定 - Profile0 を含め、無効なプロファイルへの切り替えを禁止します。
通知 API:
通知の登録/登録解除は、以下に関連するステータス変更通知の受信について、アプリで登録または登録解除することができます:
クエリ API:
スキャナの列挙 - デバイスで使用可能なスキャナのインデックスを生成します。
アクティブ プロファイルの取得 - DataWedge で現在使用中のプロファイルの名前を取得します。
構成の取得 - 指定されたプロファイルの PARAM_LIST 設定を取得します。この設定は、値ペアのセットまたはプラグイン構成バンドルとして返されます。
DataWedge ステータスの取得 - DataWedge のステータスとして有効または無効を返します。
無効アプリ リストの取得 - DataWedge の使用を禁止されたアプリやアクティビティのリストを返します。
無効なプロファイルを無視の取得 - [無効なプロファイルを無視] パラメータのステータスを返します。true の場合、有効になっていないプロファイルには切り替わりません。
プロファイル リストの取得 - DataWedge プロファイルのリストを返します。
スキャナ ステータスの取得 - 現在デフォルトとして選択されているスキャナのステータスを返します。
バージョン情報の取得 - デバイスにインストールされている DataWedge および Scanner Framework/Decoder library の現在のバージョンを返します。
重量の取得とスケールのゼロ設定 - 接続されたスケールに載っている対象物の重量を取得した後、スケールをゼロにリセットして、次の対象物を計量できる状態にします。
ランタイム API:
DataWedge の有効化/無効化 - デバイス上の DataWedge を有効/無効にします。
スキャナ入力プラグインの有効化/無効化 - 現在アクティブなプロファイルで使用中のスキャナ入力プラグインを有効/無効にします。これにより、スキャンが事実上無効になります。
トリガの列挙 - デバイスのサポートされているトリガ リストを取得します。
ワークフローの列挙 - デバイスでサポートされているワークフローを取得します。
通知 (Bluetooth スキャナ通知) - RSM (リモート スキャナ管理) により、接続されている Bluetooth スキャナでスキャンした後に、通知音の再生またはカラー LED の表示、あるいはその両方を行います。
カスタム Bluetooth スキャナ通知 - 特定の LED パターン、ビープ音、および振動シーケンスを設定して、Bluetooth スキャナによるスキャン時の通知をカスタマイズします。
フレームの要求 - イメージャ フレーム ストリーミング ワークフロー中に 1 つの画像フレームを要求します。
デフォルト プロファイルのリセット - デフォルト プロファイルを、関連付けられていないアプリで使用される組み込みプロファイル Profile0 にリセットします。
デフォルト プロファイルの設定 - 指定したプロファイルをデフォルト プロファイルとして設定します。
ソフト RFID トリガ - ソフトウェア RFID トリガを開始、停止、または切り替えます。
ソフト スキャン トリガ - ソフトウェア スキャン トリガを開始、停止、または切り替えます。
ソフト トリガ - 音声入力用のソフトウェア トリガを開始、停止、または切り替えます。
データ キャプチャの切り替え - バーコード スキャンとバーコード強調を切り替えるか、ワークフロー入力のオプションを実行時に切り替えます。
スキャナの切り替え - 実行時に特定のスキャナに切り替え、アプリ、要件、または状況に最適なスキャン デバイスを有効にします。
スキャナ パラメータの切り替え - 1 つ以上のバーコード、スキャナ、またはリーダーの、あるいはそのすべてのパラメータをインテント エクストラとして渡すことにより、実行時にアクティブなプロファイルの設定を一時的に更新します。
プロファイルの切り替え - アプリの関連付けを、指定したプロファイルに変更します。