Barcode Scanner Emulator
Префикс и суффикс сканера штрихкодов: полное руководство
Префикс — это данные или управляющая последовательность, которую сканер штрихкодов отправляет перед декодированным штрихкодом. Суффикс — то, что он отправляет после этого значения. Одну и ту же модель можно настроить на разные префиксы и суффиксы, и последовательный сканер передаёт их иначе, чем сканер в режиме клавиатурного клина.
Префикс сканера штрихкодов отправляется перед декодированным значением. Суффикс отправляется после него. Один сканер может выдать такую последовательность:
Префикс: STX
Штрихкод: 123456789
Суффикс: ENTER
STX в руководстве обычно означает управляющий символ, а не три буквы S, T и X. ENTER у сканера в режиме клавиатурного клина — это, как правило, клавиша Enter, а не два символа CR и LF, вставленные в текстовое поле. Что именно вы получите, зависит от модели, интерфейса и приложения. Универсальной настройки нет.
Руководство Суффиксы ENTER и TAB в сканерах штрихкодов остаётся на выборе и проверке этих двух завершающих клавиш. Это руководство — про рамку вокруг штрихкода: что идёт перед ним, что идёт после и как веб-приложение должно читать и то, и другое.
Что такое префикс сканера штрихкодов
Префикс — это настроенная последовательность, которую сканер передаёт перед полезной нагрузкой. Полезная нагрузка — это текст, который декодировала символика, например 123456789. Префикс не входит в это декодирование, если сканер не настроен его добавлять.
Обычные применения:
- Отметить начало сообщения. Последовательные и терминальные протоколы иногда отправляют управляющий символ, часто называемый STX, чтобы хост понял, что начался новый кадр.
- Назвать символику. Если включён идентификатор символики AIM, сканер может отправить короткий печатаемый префикс, например
]C1для Code 128 или]E0для EAN, перед цифрами. Приложение может выбрать ветку по этому идентификатору. - Направить ввод в старом ПО кассы или терминала. Фиксированный код перед данными сообщал хосту, к какому полю или устройству относится сканирование.
- Пометить конкретный пост. Двум сканерам можно задать разные печатаемые префиксы, чтобы журнал показал, какая линия отправила код.
Печатаемый префикс — это обычные символы. Они появляются в текстовом поле в начале строки. Префикс из управляющего символа, например 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. Не считайте, что пункт меню с именем LF набирает видимый символ или второй Enter.
CRLF. CR, затем LF: два байта 0x0D 0x0A. Некоторые последовательные и терминальные хосты ждут эту пару как конец строки. Текстовое поле браузера не сохраняет эту пару, когда кто-то нажимает Enter.
Свои символы. Печатаемый суффикс, например # или короткий код, набирается после штрихкода и становится частью строки, если приложение его не удалит. Свой управляющий символ подчиняется тому же разделению, что и STX: байты на последовательном порту, нажатия на клине и только те нажатия, которые клавиатурный интерфейс действительно может отправить.
ENTER, CR и LF в руководствах — родственные имена для «конца строки». Они не взаимозаменяемы в каждом приложении. Сканер-клин, последовательный сканер, Notepad и веб-форма могут показать разный результат для настройки с одним и тем же именем.
Префикс и суффикс
| Свойство | Префикс | Суффикс |
|---|---|---|
| Положение | Перед данными штрихкода | После данных штрихкода |
| Назначение | Отметить начало или пометить ввод | Отметить завершение или запустить действие |
| Пример | STX или печатаемый идентификатор AIM, например ]C1 |
ENTER, TAB или печатаемый символ, например # |
| Обычное применение | Обрамить или опознать сканирование | Отправить форму или перенести фокус |
| В текстовом поле | Печатаемые символы стоят в начале значения | Печатаемые символы стоят в конце. Enter и Tab — нет |
| Природа | Настроенная метка, которую может набрать кто угодно | Настроенная метка, которую может набрать кто угодно |
Удаляйте префикс или свой суффикс только тогда, когда вы настроили именно эту последовательность и сохранённая запись не должна её содержать. Идентификатор AIM оставляйте, пока у приложения нет правила для него.
ENTER, TAB, CR и LF
Эти имена встречаются на листах настройки. Принимающая сторона видит либо нажатия, либо байты, в зависимости от интерфейса. Руководство Клавиатурный клин HID описывает путь нажатий. Последовательный порт — другой путь: приложение читает байты, и фокус не выбирает, куда они попадут.
ENTER
У сканера в режиме клавиатурного клина ENTER — это клавиша Enter. В однострочном текстовом поле текущие браузеры используют эту клавишу, чтобы отправить окружающую форму. Поле поиска может зафиксировать сканирование по этому событию. Форма с несколькими полями может отправиться до заполнения следующих полей. Вызовите preventDefault() на событии submit или на keydown клавиши Enter, если страница должна сохранить значение и остаться на месте. Обрабатывайте Enter в одном месте. Слушатель keydown и слушатель submit, которые оба принимают сканирование, запишут его дважды.
Некоторые сканеры отправляют NumPad Enter. event.key по-прежнему равен "Enter". event.code может быть "NumpadEnter", а не "Enter". Проверяйте event.key, если фиксировать поле должны обе клавиши.
Руководство Суффиксы ENTER и TAB в сканерах штрихкодов сравнивает эти два варианта для POS и веб-форм. Статья У сканера штрихкодов нет ENTER разбирает сканер, который набирает штрихкод и затем останавливается.
TAB
TAB — это клавиша Tab. Браузер переносит фокус после keydown. Читайте поле в этом обработчике keydown, пока фокус ещё у него, и оставляйте действие по умолчанию, если курсор должен перейти к следующему элементу. preventDefault() удерживает фокус на текущем поле.
Shift+Tab — та же клавиша с зажатым Shift. Суффикс Tab у сканера — это Tab без Shift. Не смотрите на event.shiftKey, если пользователи клавиатуры должны иметь возможность двигаться по форме назад.
CR
Возврат каретки переносит курсор в начало строки в терминале. Байт — 0x0D. Последовательный сканер может дописать этот байт к полезной нагрузке. Настройка клавиатурного клина с именем CR обычно отправляет клавишу Enter, а не вставляет 0x0D в текст. Нажатие Enter в поле браузера не записывает символ CR в input.value.
Если хост — терминал или программа, слушающая 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 не входят в строку штрихкода.
- Сравните этот результат с настройкой, которую вы задавали. Затем откройте тестер событий клавиатуры и сканируйте снова, когда нужен каждый
keydownпо порядку, включаяkey,codeи время.
Тестер ввода записывает события клавиатуры, которые видит браузер. Он не может читать последовательный порт, поэтому не может показать CR или LF как сырые байты. Проверка клина не доказывает, что отправит последовательная настройка.
Устранение неполадок
Сканер не отправляет ENTER. Штрихкод появляется, а курсор остаётся в поле. Тестер ввода сообщает Нет. Суффикс выключен или задан не как Enter. См. У сканера штрихкодов нет ENTER.
TAB переносит фокус неожиданно. Сканер отправляет клавишу Tab. Это настроенный суффикс. Используйте Enter, когда форма должна отправиться, или читайте значение на keydown клавиши Tab, когда сценарий должен перейти дальше. Подробности — в руководстве Суффиксы ENTER и TAB в сканерах штрихкодов.
Форма отправляется дважды. Браузер отправляет её по Enter, и слушатель keydown тоже принимает сканирование. Оставьте один путь завершения и вызовите preventDefault() на другом.
Префикс оказывается внутри штрихкода. Печатаемый префикс входит в захваченную строку. Либо отключите его на сканере, либо удалите в приложении именно эту последовательность. Включённый идентификатор символики — частый источник ведущего ] и ещё двух символов. Управляющий префикс, который клин не может набрать, будет отсутствовать, а не виден.
Символы неверны. Раскладка сканера и раскладка операционной системы могут не совпадать, и тогда меняются символы префикса и знаки препинания, а длина остаётся той же. См. Неверная раскладка клавиатуры сканера штрихкодов.
Приложение так и не видит конец сканирования. Суффикса нет, а страница ждёт Enter. Добавьте суффикс, который подходит форме, или завершайте значение явным действием. Догадка по времени пропустит часть настоящих сканирований и примет часть набора с клавиатуры.
CR/LF различается между приложениями. Notepad вставляет новую строку, когда получает Enter. Веб-поле хранит штрихкод и порождает событие клавиши. Последовательная программа может получить 0x0D, 0x0A или оба байта. Сравните интерфейс, прежде чем менять сканер. Если ни одно приложение не получает символы, начните со статьи Сканер штрихкодов не работает.
Более широкий разбор фокуса, повторных сканирований и сценариев POS — в руководстве Как тестировать ввод со сканера штрихкодов.
Матрица тестов
Столбец настройки — это то, что вы задаёте на сканере, или то, что набираете эмулятором, когда случай относится к клавиатурному суффиксу. Ожидаемое поведение — то, что должно сделать приложение. Случай последовательного CRLF — не тот же тест, что клавиша Enter в браузере.
| Настройка | Ожидаемое поведение приложения |
|---|---|
| Нет префикса, нет суффикса | Значение штрихкода получено, и завершающая клавиша не приходит. Значение остаётся доступным, пока приложение его не прочитает. |
| Нет префикса, суффикс ENTER | Приложение получает завершающую клавишу один раз и сохраняет полезную нагрузку без символа-завершителя. |
| Нет префикса, суффикс TAB | Фокус может перейти к следующему элементу. Приложение читает значение до этого перехода. |
| Свой печатаемый префикс | Символы префикса появляются перед декодированными данными. Приложение намеренно оставляет или удаляет именно этот префикс. |
| Свой печатаемый суффикс | Символы суффикса появляются после декодированных данных. Enter и Tab — клавиши, поэтому в строке они не появляются. |
| Последовательность CRLF | Последовательный или терминальный хост обрабатывает настроенные байты CR и LF. Текстовое поле браузера не получает эти байты от нажатия Enter. |
Клавиатурные строки прогоняйте на сканере-клине и, когда оборудования нет, с настройками эмулятора ENTER, TAB и без суффикса. Строку CRLF прогоняйте на том интерфейсе, который должен нести эти байты. Фактический результат всё равно зависит от этого интерфейса и от приложения.