Barcode Scanner Emulator
バーコードスキャナーの接頭辞と接尾辞: 完全ガイド
接頭辞は、バーコードスキャナーが復号したバーコードの前に送るデータまたは制御シーケンスです。接尾辞は、その値のあとに送るものです。同じ機種でも接頭辞と接尾辞は別々に設定でき、シリアルスキャナーはキーボードウェッジのスキャナーと同じ届け方をしません。
バーコードスキャナーの接頭辞は、復号した値の前に送られます。接尾辞は、その値のあとに送られます。あるスキャナーは、次の並びを出すことがあります。
接頭辞: STX
バーコード: 123456789
接尾辞: ENTER
マニュアルの STX は、多くの場合、S、T、X の三文字ではなく制御文字を指します。キーボードウェッジのスキャナーでの ENTER は、通常 Enter キーであり、テキスト欄へ挿入される CR と LF の二文字ではありません。どれを受け取るかは、機種、インターフェース、アプリケーションによります。どの設定も万能ではありません。
バーコードスキャナーの ENTER と TAB の接尾辞は、その二つの終端の選び方と切り分けに留まります。このガイドが扱うのは、バーコードを囲む枠です。前に何が来るか、あとに何が来るか、ウェブアプリケーションが両方をどう読むかです。
バーコードスキャナーの接頭辞とは
接頭辞は、スキャナーがペイロードの前に送るよう設定された列です。ペイロードは、シンボル体系が復号したテキストで、たとえば 123456789 です。スキャナーが付けるよう設定されていない限り、接頭辞はその復号結果の一部ではありません。
よくある用途:
- メッセージの開始を示す。 シリアルや端末のプロトコルは、新しいフレームが始まったことをホストへ知らせるため、しばしば STX と呼ばれる制御文字を送ることがあります。
- シンボル体系に名前を付ける。 AIM のシンボル体系識別子を有効にすると、スキャナーは Code 128 なら
]C1、EAN なら]E0のような、短い印字可能な接頭辞を数字の前に送れます。アプリケーションはその識別子で処理を分けられます。 - 古い POS や端末ソフトで入力を振り分ける。 データの前にある固定コードが、そのスキャンがどの欄や機器のものかをホストへ伝えていました。
- 特定のレーンを印す。 二つのスキャナーに別々の印字可能な接頭辞を付けると、ログでどのレーンがコードを送ったか分かります。
印字可能な接頭辞は普通の文字です。テキスト欄では文字列の先頭に現れます。STX(0x02)のような制御文字の接頭辞は、S、T、X の文字ではありません。キーボードウェッジのスキャナーは、その制御文字を打てないことがあります。シリアルスキャナーは、それをバイトとして送れます。どちらかを期待するコードを書く前に、手元の機種のマニュアルを読んでください。
接頭辞は、入力をスキャナーが作った証明にはなりません。人、マクロ、Barcode Scanner Emulator も同じ文字を打てます。接頭辞は、自分で設定した枠として扱い、ペイロードはほかのユーザー入力と同じように検証してください。
バーコードスキャナーの接尾辞とは
接尾辞は、ペイロードのあとに送るよう設定された列です。通常の役割は、スキャンが終わったことをアプリケーションへ伝えるか、フォーカスを動かすことです。スキャナーによって違います。Enter、Tab、CR、LF、CR+LF、任意の文字列、またはなしを選べるものもあれば、そのうち一つか二つしかないものもあります。
ENTER。 Enter キーです。ブラウザではキーボードイベントで、event.key === "Enter" です。通常のテキスト入力へは挿入されません。
TAB。 Tab キーで、event.key === "Tab" です。ブラウザはフォーカスを次のコントロールへ移します。キーは欄へ挿入されません。
CR。 キャリッジリターン、ASCII の 0x0D です。シリアルや端末のインターフェースでは、ペイロードのあとの実バイトになり得ます。キーボードウェッジでは、CR やキャリッジリターンと書かれた設定は、通常 Enter キーを意味します。ブラウザはやはり Enter と報告します。欄の値に CR 文字は入りません。
LF。 ラインフィード、ASCII の 0x0A です。CR とは別の制御文字です。シリアルのストリームでは、独立したバイトになり得ます。キーボードウェッジには、Enter や Tab のような標準の Line Feed キーはありません。LF というメニュー項目が、見える文字や二度目の Enter を打つとは考えないでください。
CRLF。 CR のあとに LF が続く、0x0D と 0x0A の二バイトです。一部のシリアルや端末のホストは、行末としてこの組を期待します。誰かが Enter を押しても、ブラウザのテキスト欄はこの組を保存しません。
任意の文字。 # や短いコードのような印字可能な接尾辞は、バーコードのあとに打たれるので、アプリケーションが取り除かない限り文字列の一部になります。任意の制御文字は STX と同じ分かれ方です。シリアルポートではバイト、ウェッジではキー入力、そしてキーボードインターフェースが実際に送れるキー入力だけです。
ENTER、CR、LF は、マニュアルでは行末を指す近い名前です。どのアプリケーションでも入れ替えられるわけではありません。ウェッジスキャナー、シリアルスキャナー、メモ帳、ウェブフォームは、同じ名前の設定でも別の結果を示すことがあります。
接頭辞と接尾辞
| 項目 | 接頭辞 | 接尾辞 |
|---|---|---|
| 位置 | バーコードデータの前 | バーコードデータのあと |
| 目的 | 開始を示すか、入力にラベルを付ける | 完了を示すか、動作を起こす |
| 例 | STX、または ]C1 のような印字可能な AIM 識別子 |
ENTER、TAB、または # のような印字可能な文字 |
| よくある用途 | スキャンを枠づけるか識別する | フォームを送信するか、フォーカスを移す |
| テキスト欄では | 印字可能な文字が値の先頭に並ぶ | 印字可能な文字が末尾に並ぶ。Enter と Tab は並ばない |
| 性質 | 誰でも打てる、設定された印 | 誰でも打てる、設定された印 |
接頭辞や任意の接尾辞を取り除くのは、その列を正確に設定していて、保存する記録に含めたくないときだけにしてください。AIM 識別子は、アプリケーションに扱いの規則ができるまで残します。
ENTER、TAB、CR、LF
これらの名前は設定シートに出ます。受け取る側が見るのは、インターフェースによってキー入力かバイトです。HID キーボードウェッジの解説は、キー入力の経路を説明します。シリアルポートは別の経路です。アプリケーションはバイトを読み、フォーカスは行き先を選びません。
ENTER
キーボードウェッジのスキャナーでは、ENTER は Enter キーです。一行のテキスト欄では、現在のブラウザはそのキーで囲んでいるフォームを送信します。検索欄は、そのイベントでスキャンを確定できます。複数欄のフォームは、あとの欄を埋める前に送信されることがあります。ページが値を残してその場に留まるべきときは、submit イベントか、Enter の keydown で preventDefault() を呼びます。Enter の扱いは一箇所にします。スキャンを受け付ける keydown リスナーと submit リスナーの両方があれば、二度記録されます。
一部のスキャナーは NumPad Enter を送ります。event.key はやはり "Enter" です。event.code は "Enter" ではなく "NumpadEnter" になることがあります。両方のキーで欄を確定するなら、event.key を調べます。
バーコードスキャナーの ENTER と TAB の接尾辞は、POS とウェブフォームでのその二つの選び方を比べます。バーコードスキャナーで ENTER が出ないは、バーコードを打ったあと止まるスキャナーを扱います。
TAB
TAB は Tab キーです。ブラウザは keydown のあとでフォーカスを移します。その keydown ハンドラの中、まだフォーカスがあるうちに欄を読み、次のコントロールがカーソルを受けるべきときは既定の動作を残します。preventDefault() は、現在の欄にフォーカスを留めます。
Shift+Tab は、Shift を押した同じキーです。スキャナーの Tab 接尾辞は、Shift のない Tab です。キーボードの利用者がフォームを逆方向へ移動できる必要があるなら、event.shiftKey は無視します。
CR
キャリッジリターンは、端末でカーソルを行頭へ移します。バイトは 0x0D です。シリアルスキャナーは、そのバイトをペイロードへ付加できます。CR という名前のキーボードウェッジ設定は、通常、テキストへ 0x0D を挿入する代わりに Enter キーを送ります。ブラウザの入力で Enter を押しても、input.value へ CR 文字は書かれません。
ホストが端末や COM ポートのリスナーなら、バイトを探します。ホストがウェブページなら、event.key === "Enter" を探します。
LF
ラインフィードは、端末のカーソルを一行下げます。バイトは 0x0A です。LF だけを改行として扱うホストもあれば、CR が先に来ない限り無視するホストもあります。接尾辞として LF を載せるウェッジスキャナーは、オペレーティングシステムが改行にしないキーを送るか、テキスト欄が残さないものを送ることがあります。想定した LF をアプリケーションのコードで扱う前に、キーボードイベントテスターでキーを取得してください。
CRLF
CRLF は、CR の次に LF が来る二つの制御の列です。Windows 形式のテキストファイルと多くのシリアル機器は、これを一つの改行として使います。CRLF 接尾辞と書かれた設定ページは、使っているインターフェースで、スキャナーがその組をペイロードのあとへ送ろうとすることを意味します。
ブラウザでは、Enter を押してもテキスト入力の中に文字どおりの CRLF 列は生まれません。フォームが受け取るのはキーボードイベントです。<textarea> は、ユーザーが Enter を押したときに改行を挿入することがあり、その改行はブラウザ自身の編集動作であって、スキャナーが 0x0D 0x0A のバイトを出した証明ではありません。シリアルの読み取り側は、その二バイトを受け取れます。そのスキャナーが送るよう設定されているときだけ、終端として扱ってください。含めることが許されたペイロードの途中から、CR や LF を取り除かないでください。
接頭辞と接尾辞がウェブアプリケーションに与える影響
キーボードウェッジのスキャンは、フォーカスのあるコントロールへのキー入力の連なりです。ページはスキャナーを開きません。別の欄にフォーカスがあると、接頭辞もバーコードも接尾辞もそこへ行きます。
keydown は、Enter と Tab を含むすべてのキーで、ブラウザが文字を挿入したりフォーカスを移したりする前に発火します。event.key は、オペレーティングシステムがキーボード配列を適用したあとの文字またはキー名です。印字可能な接頭辞と接尾辞の文字は、input イベントを通じて欄に現れます。Enter と Tab は現れません。
下のリスナーは、Enter が来たときに欄を確定します。スキャナーが省いた接尾辞は足しません。スキャナーが Enter を送らないなら、ほかの何かが読むまで値は欄に残ります。
const field = document.querySelector('#barcode')
if (!(field instanceof HTMLInputElement)) {
throw new Error('Barcode field was not found.')
}
field.addEventListener('keydown', (event) => {
if (event.key !== 'Enter') {
return
}
event.preventDefault()
const value = field.value.trim()
if (!value) {
return
}
console.log(value)
field.value = ''
})
スキャンの前に #barcode へフォーカスを置きます。preventDefault() は、祖先のフォームが二度目に送信するのを止めます。入力がフォームの中になく、ブラウザ本来の送信が欲しいときは、preventDefault() を省きます。
接尾辞がないときは、明示的な操作を待ちます。ボタン、操作者によるあとの Enter、またはワークフローの次の段階です。無操作のタイマーは、間をスキャンの終わりとして扱えます。そのタイマーは経験則です。遅いスキャナー、Bluetooth の遅延、速い入力者は、そのどちら側にも外れます。ワークフローに確かな終わりが必要なら、設定した接尾辞を優先します。
分かっている印字可能な接頭辞は、値を読んだあとで取り除けます。
function withoutConfiguredPrefix(value, prefix) {
if (prefix && value.startsWith(prefix)) {
return value.slice(prefix.length)
}
return value
}
渡すのは、設定した接頭辞だけです。たとえば ']C1' です。すべてのスキャンから、決めていない文字数を削らないでください。
Tab、空の入力、二度目のスキャンも扱うフォーム全体は、ウェブアプリケーションでバーコードスキャナーをテストする方法を参照してください。
接頭辞と接尾辞の設定方法
接頭辞と接尾辞の設定はスキャナーにあります。キーの名前と変更のしかたはメーカーごとに違います。すべてのブランドで動く設定用バーコードはなく、このガイドはそれを掲載しません。
典型的な方法:
- その機種のマニュアルにある設定用バーコードをスキャンします。シートは設定ごとにまとまっています。接尾辞、接頭辞、キーボード配列、シンボル体系です。
- ベンダーの設定プログラムを使い、結果を USB 経由でスキャナーへ書き込みます。
- 多くの台を更新するときは、その製品系列の機器管理ユーティリティを使います。
変更したあと、値が分かっているバーコードをスキャンし、選んだ設定についてマニュアルが述べる内容と結果を比べます。別ブランドの工場出荷時リセットは、スキャナーを変えないか、予期しないモードに入れることがあります。バーコードスキャナー設定ガイドは、たいてい重要になる設定をまとめています。マニュアルの代わりにはなりません。
Barcode Scanner Emulator は、選んだ値を打ち、そのあと ENTER、TAB、または接尾辞なしを送れます。ハードウェアなしで接頭辞の扱いを試すときは、その値に印字可能な接頭辞を入れてください。エミュレーターはシリアルの CR/LF バイト対を出さず、ラベルも読みません。
接頭辞と接尾辞の動作をテストする方法
キーボードモードのスキャナーを使います。USB HID キーボード、または Bluetooth HID キーボードです。
- 接続し、電源が入ったことを示すまで待ちます。
- バーコード入力テスターを開きます。
- テスト開始をクリックするか、スキャン領域をクリックします。準備ができると青くなります。ページが自分からフォーカスを取ることはありません。
- ペイロードをすでに知っているバーコードをスキャンします。
- 取得した値と文字数を読みます。印字可能な接頭辞や接尾辞の文字は、その文字列の中にあります。接頭辞の行は、最初の文字より前に届く名前付きのキー、たとえば修飾キーのためのものです。
]C1のような打たれた接頭辞を、バーコードのテキストから抜き出しません。 - 接尾辞を確認します。テスターは ENTER、TAB、またはなしを報告します。自動取得がオンのとき、結果は Enter、Tab、またはキーが止まったあとの短い間のあとへ現れます。自動取得をオフにすると、停止を押すまで取得を保持します。Enter と Tab はバーコード文字列の一部ではありません。
- その結果を、意図した設定と比べます。
key、code、タイミングを含む各keydownを順に見る必要があるときは、キーボードイベントテスターを開いてもう一度スキャンします。
入力テスターは、ブラウザが見られるキーボードイベントを記録します。シリアルポートは読めないので、CR や LF を生のバイトとしては示せません。ウェッジでのテストは、シリアル設定が何を送るかの証明にはなりません。
切り分け
スキャナーが ENTER を送らない。 バーコードは現れ、カーソルは欄に残ります。入力テスターはなしを報告します。接尾辞がオフか、Enter 以外に設定されています。バーコードスキャナーで ENTER が出ないを参照してください。
TAB が予期せずフォーカスを移す。 スキャナーが Tab キーを送っています。それが設定された接尾辞です。フォームを送信するべきときは Enter を使い、ワークフローを進めるべきときは Tab の keydown で値を読みます。詳細は バーコードスキャナーの ENTER と TAB の接尾辞 にあります。
フォームが二度送信される。 ブラウザが Enter で送信し、keydown リスナーもスキャンを受け付けています。完了の経路は一つにし、もう一方で preventDefault() を呼びます。
接頭辞がバーコードの中に現れる。 印字可能な接頭辞は、取得した文字列の一部です。スキャナーで無効にするか、アプリケーションでその列だけを取り除きます。有効なシンボル体系識別子は、先頭の ] とさらに二文字のよくある出所です。ウェッジが打てない制御接頭辞は、見える代わりに欠けることになります。
文字が違う。 スキャナーの配列とオペレーティングシステムの配列が食い違うと、長さは同じままで接頭辞の文字や句読点が変わります。バーコードスキャナーのキーボード配列が違うを参照してください。
アプリケーションがスキャンの終わりを見ない。 接尾辞がなく、ページは Enter を待っています。フォームに合う接尾辞を付けるか、明示的な操作で値を確定します。タイミングの推測は、本物のスキャンを見逃し、入力の一部を受け入れます。
CR/LF がアプリケーションによって違う。 メモ帳は Enter を受け取ると改行を挿入します。ウェブのテキスト入力はバーコードを残し、キーイベントを発火します。シリアルのプログラムは 0x0D、0x0A、または両方を受け取ることがあります。スキャナーを変える前に、インターフェースを比べてください。どのアプリケーションも文字を受け取らないときは、バーコードスキャナーが動作しないから始めてください。
フォーカス、繰り返しのスキャン、POS の流れを広く見る手順は、バーコードスキャナー入力のテスト方法にあります。
テスト行列
設定の列は、スキャナーに設定した内容、またはキーボード接尾辞のケースでエミュレーターに打たせた内容です。期待する動作は、アプリケーションがすべきことです。シリアルの CRLF のケースは、ブラウザの Enter キーと同じテストではありません。
| 設定 | アプリケーションに期待する動作 |
|---|---|
| 接頭辞なし、接尾辞なし | バーコードの値が届き、完了のキーは来ません。アプリケーションが読むまで、値は残ります。 |
| 接頭辞なし、ENTER 接尾辞 | アプリケーションは完了のキーを一度受け取り、終端文字なしでペイロードを保存します。 |
| 接頭辞なし、TAB 接尾辞 | フォーカスは次のコントロールへ移ることがあります。アプリケーションはその移動の前に値を読みます。 |
| 任意の印字可能な接頭辞 | 接頭辞の文字が、復号したデータの前に現れます。アプリケーションはその接頭辞を、意図して残すか取り除きます。 |
| 任意の印字可能な接尾辞 | 接尾辞の文字が、復号したデータのあとに現れます。Enter と Tab はキーなので、文字列には現れません。 |
| CRLF の列 | シリアルまたは端末のホストが、設定された CR と LF のバイトを処理します。ブラウザのテキスト欄は、Enter のキー押下からそれらのバイトを得ません。 |
キーボードの行はウェッジスキャナーで、ハードウェアがないときはエミュレーターの ENTER、TAB、接尾辞なしの設定で実行します。CRLF の行は、それらのバイトを運ぶはずのインターフェースで実行します。実際の結果は、そのインターフェースとアプリケーションに依存します。