Aller au contenu

Barcode Scanner Emulator

Préfixe et suffixe du lecteur de codes-barres : guide complet

Un préfixe est une donnée ou une séquence de contrôle qu'un lecteur de codes-barres envoie avant le code-barres décodé. Un suffixe est ce qu'il envoie après cette valeur. Le même modèle peut recevoir des préfixes et des suffixes différents, et un lecteur série ne les livre pas de la même façon qu'un lecteur en émulation clavier.

Un préfixe de lecteur de codes-barres est envoyé avant la valeur décodée. Un suffixe est envoyé après. Un lecteur peut produire cette séquence :

Préfixe : STX

Code-barres : 123456789

Suffixe : ENTER

Dans un manuel, STX désigne souvent le caractère de contrôle, pas les trois lettres S, T et X. Sur un lecteur en émulation clavier, ENTER est en général la touche Entrée, pas les deux caractères CR et LF insérés dans un champ de texte. Ce que vous recevez dépend du modèle, de l'interface et de l'application. Aucun réglage ne vaut pour tous les appareils.

Le guide Suffixes ENTER et TAB des lecteurs de codes-barres reste sur le choix et le dépannage de ces deux terminaisons. Ce guide porte sur le cadre autour du code-barres : ce qui vient avant, ce qui vient après, et comment une application web doit lire les deux.

Qu'est-ce qu'un préfixe de lecteur de codes-barres ?

Un préfixe est une séquence configurée que le lecteur transmet avant la charge utile. La charge utile est le texte décodé par la symbologie, par exemple 123456789. Le préfixe ne fait pas partie de ce décodage, sauf si le lecteur a été réglé pour l'ajouter.

Usages courants :

  • Marquer le début d'un message. Les protocoles série et terminal envoient parfois un caractère de contrôle, souvent appelé STX, pour que l'hôte sache qu'une nouvelle trame a commencé.
  • Nommer la symbologie. Lorsque l'identifiant de symbologie AIM est activé, un lecteur peut envoyer un court préfixe imprimable tel que ]C1 pour le Code 128 ou ]E0 pour l'EAN, avant les chiffres. L'application peut se brancher sur cet identifiant.
  • Aiguiller la saisie dans un ancien logiciel de POS ou de terminal. Un code fixe avant les données indiquait à l'hôte à quel champ ou appareil la lecture appartenait.
  • Étiqueter un poste précis. Deux lecteurs peuvent recevoir des préfixes imprimables différents, afin qu'un journal montre quelle file a envoyé le code.

Un préfixe imprimable est constitué de caractères ordinaires. Ils apparaissent dans un champ de texte au début de la chaîne. Un préfixe de caractère de contrôle, tel que STX (0x02), n'est pas les lettres S, T et X. Un lecteur en émulation clavier peut être incapable de taper ce caractère de contrôle. Un lecteur série peut l'envoyer comme un octet. Lisez le manuel du modèle que vous avez avant d'écrire du code qui attend l'un ou l'autre.

Un préfixe ne prouve pas qu'un lecteur a produit la saisie. Une personne, une macro ou le Barcode Scanner Emulator peut taper les mêmes caractères. Traitez un préfixe comme un cadrage que vous avez configuré, puis validez la charge utile comme n'importe quelle autre saisie utilisateur.

Qu'est-ce qu'un suffixe de lecteur de codes-barres ?

Un suffixe est une séquence configurée envoyée après la charge utile. Son rôle habituel est de dire à l'application que la lecture est terminée, ou de déplacer le focus. Les lecteurs diffèrent. Certains proposent Entrée, Tabulation, CR, LF, CR+LF, une chaîne personnalisée, ou rien. Certains n'en proposent qu'une ou deux.

ENTER. La touche Entrée. Dans un navigateur, c'est un événement clavier, event.key === "Enter". Elle n'est pas insérée dans un champ de texte ordinaire.

TAB. La touche Tabulation, event.key === "Tab". Le navigateur déplace le focus vers le contrôle suivant. La touche n'est pas insérée dans le champ.

CR. Retour chariot, ASCII 0x0D. Sur une interface série ou terminal, cela peut être un octet réel après la charge utile. Sur une émulation clavier, un réglage intitulé CR ou retour chariot signifie en général la touche Entrée. Le navigateur signale toujours Entrée. La valeur du champ ne gagne pas un caractère CR.

LF. Saut de ligne, ASCII 0x0A. C'est un caractère de contrôle distinct de CR. Sur un flux série, il peut être son propre octet. Une émulation clavier n'a pas de touche Saut de ligne standard comme elle a Entrée et Tabulation. Ne supposez pas qu'une entrée de menu nommée LF tape un caractère visible ou une seconde Entrée.

CRLF. CR suivi de LF, les deux octets 0x0D 0x0A. Certains hôtes série et terminal attendent cette paire comme fin de ligne. Un champ de texte du navigateur ne stocke pas cette paire lorsque quelqu'un appuie sur Entrée.

Caractères personnalisés. Un suffixe imprimable tel que # ou un code court est tapé après le code-barres, donc il devient une partie de la chaîne, sauf si l'application le retire. Un caractère de contrôle personnalisé suit le même partage que STX : des octets sur un port série, des frappes sur une émulation, et seulement les frappes que l'interface clavier peut réellement envoyer.

ENTER, CR et LF sont des noms apparentés pour la fin de ligne dans les manuels. Ils ne sont pas interchangeables dans chaque application. Un lecteur en émulation, un lecteur série, Notepad et un formulaire web peuvent chacun montrer un résultat différent pour un réglage du même nom.

Préfixe et suffixe

Caractéristique Préfixe Suffixe
Position Avant les données du code-barres Après les données du code-barres
Rôle Marquer le début ou étiqueter la saisie Marquer la fin ou déclencher une action
Exemple STX, ou un identifiant AIM imprimable tel que ]C1 ENTER, TAB, ou un caractère imprimable tel que #
Usage courant Cadrer ou identifier la lecture Envoyer un formulaire ou déplacer le focus
Dans un champ de texte Les caractères imprimables sont au début de la valeur Les caractères imprimables sont à la fin. Entrée et Tabulation non
Identité Un marqueur configuré que n'importe qui peut taper Un marqueur configuré que n'importe qui peut taper

Ne retirez un préfixe ou un suffixe personnalisé que si vous avez configuré exactement cette séquence et que l'enregistrement stocké ne doit pas l'inclure. Laissez un identifiant AIM en place jusqu'à ce que l'application ait une règle pour lui.

ENTER, TAB, CR et LF

Ces noms figurent sur les fiches de configuration. Le côté qui reçoit voit soit des frappes, soit des octets, selon l'interface. Le guide Émulation clavier HID décrit le chemin des frappes. Un port série est un autre chemin : l'application lit des octets, et le focus ne choisit pas où ils vont.

ENTER

Sur un lecteur en émulation clavier, ENTER est la touche Entrée. Dans un champ de texte d'une ligne, les navigateurs actuels utilisent cette touche pour envoyer le formulaire englobant. Une zone de recherche peut valider la lecture sur cet événement. Un formulaire à plusieurs champs peut s'envoyer avant que les champs suivants soient remplis. Appelez preventDefault() sur l'événement submit, ou sur le keydown d'Entrée, lorsque la page doit garder la valeur et rester en place. Traitez Entrée à un seul endroit. Un écouteur keydown et un écouteur submit qui acceptent tous les deux la lecture l'enregistrent deux fois.

Certains lecteurs envoient NumPad Enter. event.key reste "Enter". event.code peut être "NumpadEnter" plutôt que "Enter". Testez event.key si les deux touches doivent valider le champ.

Le guide Suffixes ENTER et TAB des lecteurs de codes-barres compare ces deux choix pour les POS et les formulaires web. Le lecteur de codes-barres n'envoie pas ENTER traite un lecteur qui tape le code-barres, puis s'arrête.

TAB

TAB est la touche Tabulation. Le navigateur déplace le focus après keydown. Lisez le champ dans ce gestionnaire keydown, tant qu'il a encore le focus, et laissez l'action par défaut en place lorsque le contrôle suivant doit recevoir le curseur. preventDefault() garde le focus sur le champ actuel.

Maj+Tab est la même touche avec Maj maintenue. Un suffixe Tab de lecteur est Tab sans Maj. Ignorez event.shiftKey si les utilisateurs du clavier doivent pouvoir reculer dans le formulaire.

CR

Le retour chariot place le curseur au début de la ligne dans un terminal. L'octet est 0x0D. Un lecteur série peut ajouter cet octet à la charge utile. Un réglage d'émulation clavier nommé CR envoie en général la touche Entrée au lieu d'insérer 0x0D dans le texte. Appuyer sur Entrée dans un champ du navigateur n'écrit pas un caractère CR dans input.value.

Si l'hôte est un terminal ou un programme à l'écoute d'un port COM, cherchez l'octet. Si l'hôte est une page web, cherchez event.key === "Enter".

LF

Le saut de ligne descend le curseur du terminal d'une ligne. L'octet est 0x0A. Certains hôtes traitent LF seul comme le saut de ligne. D'autres l'ignorent tant que CR n'est pas venu d'abord. Un lecteur en émulation qui liste LF comme suffixe peut envoyer une touche que le système d'exploitation ne transforme pas en saut de ligne, ou n'envoyer rien qu'un champ de texte conserve. Capturez la touche dans le testeur d'événements clavier avant de traiter un LF supposé dans le code de l'application.

CRLF

CRLF est la séquence de deux contrôles, CR puis LF. Les fichiers texte de style Windows et de nombreux appareils série l'utilisent comme un seul saut de ligne. Une page de configuration qui indique un suffixe CRLF signifie que le lecteur essaiera d'envoyer cette paire après la charge utile sur l'interface qu'il utilise.

Dans un navigateur, appuyer sur Entrée ne produit pas une séquence CRLF littérale dans un champ de texte. Le formulaire reçoit un événement clavier. Un <textarea> peut insérer un saut de ligne lorsque l'utilisateur appuie sur Entrée, et ce saut de ligne est le comportement d'édition du navigateur, pas la preuve que le lecteur a émis les octets 0x0D 0x0A. Un lecteur série peut recevoir ces deux octets et ne doit les traiter comme terminaison que si ce lecteur a été configuré pour les envoyer. Ne retirez pas CR ou LF du milieu d'une charge utile qui a le droit de les contenir.

Comment les préfixes et les suffixes agissent sur les applications web

Une lecture en émulation clavier est une rafale de frappes dans le contrôle qui a le focus. La page n'ouvre pas le lecteur. Si le focus est sur un autre champ, le préfixe, le code-barres et le suffixe y vont tous.

keydown se déclenche pour chaque touche, y compris Entrée et Tabulation, avant que le navigateur n'insère un caractère ou ne déplace le focus. event.key est le caractère ou le nom de touche après que le système d'exploitation a appliqué la disposition du clavier. Les caractères imprimables du préfixe et du suffixe apparaissent dans le champ par l'événement input. Entrée et Tabulation n'y apparaissent pas.

L'écouteur ci-dessous valide le champ lorsque Entrée arrive. Il n'ajoute pas un suffixe que le lecteur a omis. Si le lecteur n'envoie pas Entrée, la valeur reste dans le champ jusqu'à ce qu'autre chose la lise.

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 = ''
})

Donnez le focus à #barcode avant la lecture. preventDefault() empêche un formulaire ancêtre de s'envoyer une seconde fois. Si le champ n'est pas dans un formulaire et que vous voulez l'envoi natif, omettez preventDefault().

Sans suffixe, attendez une action explicite : un bouton, une Entrée ultérieure de l'opérateur, ou l'étape suivante du flux. Un minuteur d'inactivité peut traiter une pause comme la fin de la lecture. Ce minuteur est une heuristique. Un lecteur lent, un délai Bluetooth ou une frappe rapide peuvent tomber du mauvais côté. Préférez un suffixe configuré lorsque le flux a besoin d'une fin certaine.

Un préfixe imprimable connu peut être retiré après la lecture de la valeur :

function withoutConfiguredPrefix(value, prefix) {
  if (prefix && value.startsWith(prefix)) {
    return value.slice(prefix.length)
  }
  return value
}

Ne passez que le préfixe que vous avez configuré, par exemple ']C1'. Ne retirez pas un nombre arbitraire de caractères de chaque lecture.

Pour un formulaire complet qui gère aussi Tabulation, une saisie vide et une seconde lecture, voir Comment tester les lecteurs de codes-barres dans les applications web.

Comment configurer les préfixes et les suffixes

Les réglages de préfixe et de suffixe sont sur le lecteur. Les noms de touches et la façon de les changer dépendent du fabricant. Il n'existe pas de code-barres de configuration qui fonctionne sur toutes les marques, et ce guide n'en imprime pas.

Méthodes habituelles :

  • Lisez un code-barres de configuration tiré du manuel de ce modèle exact. La feuille est groupée par réglage : suffixe, préfixe, disposition du clavier, symbologie.
  • Utilisez le programme de configuration du fabricant, puis écrivez le résultat sur le lecteur par USB.
  • Utilisez l'utilitaire de gestion des appareils de cette gamme lorsque vous mettez à jour de nombreuses unités.

Après un changement, lisez un code-barres connu et comparez le résultat à la description, dans le manuel, du réglage choisi. Une réinitialisation d'usine d'une autre marque peut laisser le lecteur inchangé ou le placer dans un mode inattendu. Le guide Guide de configuration du lecteur de codes-barres résume les réglages qui comptent en général. Il ne remplace pas le manuel.

Le Barcode Scanner Emulator peut taper une valeur que vous choisissez, puis envoyer ENTER, TAB ou aucun suffixe. Placez un préfixe imprimable dans cette valeur lorsque vous devez exercer le traitement du préfixe sans matériel. L'émulateur n'émet pas une paire d'octets CR/LF série, et il ne lit pas une étiquette.

Comment tester le comportement du préfixe et du suffixe

Utilisez un lecteur en mode clavier, clavier HID USB ou clavier HID Bluetooth.

  1. Branchez-le et attendez qu'il indique qu'il est sous tension.
  2. Ouvrez le testeur de saisie de codes-barres.
  3. Cliquez sur Start Test, ou cliquez sur la zone de lecture. Elle devient bleue lorsqu'elle est prête. La page ne prend pas le focus d'elle-même.
  4. Lisez un code-barres dont vous connaissez déjà la charge utile.
  5. Lisez la valeur capturée et le nombre de caractères. Les caractères imprimables du préfixe ou du suffixe sont dans cette chaîne. La ligne Prefix concerne les touches nommées qui arrivent avant le premier caractère, comme un modificateur. Elle ne retire pas un préfixe tapé tel que ]C1 du texte du code-barres.
  6. Vérifiez le suffixe. Le testeur signale ENTER, TAB ou None. Avec Auto capture activé, le résultat apparaît après Entrée, Tabulation ou une courte pause une fois les touches arrêtées. Désactivez Auto capture pour garder la capture jusqu'à ce que vous appuyiez sur Stop. Entrée et Tabulation ne font pas partie de la chaîne du code-barres.
  7. Comparez ce résultat à la configuration voulue. Ouvrez ensuite le testeur d'événements clavier et relisez lorsque vous avez besoin de chaque keydown dans l'ordre, y compris key, code et le minutage.

Le testeur de saisie enregistre les événements clavier que le navigateur peut voir. Il ne peut pas lire un port série, donc il ne peut pas montrer CR ou LF comme octets bruts. Un essai en émulation clavier ne prouve pas ce qu'un réglage série enverra.

Dépannage

Le lecteur n'envoie pas ENTER. Le code-barres apparaît et le curseur reste dans le champ. Le testeur de saisie signale None. Le suffixe est désactivé, ou il est réglé sur autre chose qu'Entrée. Voir Le lecteur de codes-barres n'envoie pas ENTER.

TAB déplace le focus de façon inattendue. Le lecteur envoie la touche Tabulation. C'est le suffixe configuré. Utilisez Entrée lorsque le formulaire doit s'envoyer, ou lisez la valeur sur le keydown de Tabulation lorsque le flux doit avancer. Les détails sont dans le guide Suffixes ENTER et TAB des lecteurs de codes-barres.

Le formulaire s'envoie deux fois. Le navigateur envoie sur Entrée, et un écouteur keydown accepte aussi la lecture. Gardez un seul chemin de fin et appelez preventDefault() sur l'autre.

Un préfixe apparaît dans le code-barres. Un préfixe imprimable fait partie de la chaîne capturée. Désactivez-le sur le lecteur, ou retirez exactement cette séquence dans l'application. Un identifiant de symbologie activé est une source courante d'un ] initial et de deux caractères de plus. Un préfixe de contrôle que l'émulation ne peut pas taper sera absent au lieu d'être visible.

Les caractères sont faux. La disposition du lecteur et celle du système d'exploitation peuvent diverger, ce qui change les caractères du préfixe et la ponctuation alors que la longueur reste la même. Voir Mauvaise disposition de clavier du lecteur de codes-barres.

L'application ne voit jamais la fin de la lecture. Il n'y a pas de suffixe, et la page attend Entrée. Ajoutez un suffixe qui correspond au formulaire, ou terminez la valeur par une action explicite. Une estimation de temps manquera certaines lectures réelles et acceptera certaines frappes.

CR/LF diffère selon les applications. Notepad insère une nouvelle ligne lorsqu'il reçoit Entrée. Un champ de texte web conserve le code-barres et déclenche un événement de touche. Un programme série peut recevoir 0x0D, 0x0A, ou les deux. Comparez l'interface avant de modifier le lecteur. Si aucune application ne reçoit de caractères, commencez par Le lecteur de codes-barres ne fonctionne pas.

Un passage plus large sur le focus, les lectures répétées et les flux POS se trouve dans Comment tester la saisie d'un lecteur de codes-barres.

Matrice de test

La colonne de configuration est ce que vous réglez sur le lecteur, ou ce que vous tapez avec l'émulateur lorsque le cas est un suffixe clavier. Le comportement attendu est ce que l'application doit faire. Un cas CRLF série n'est pas le même test qu'une touche Entrée dans un navigateur.

Configuration Comportement attendu de l'application
Aucun préfixe, aucun suffixe La valeur du code-barres est reçue et aucune touche de fin n'arrive. La valeur reste disponible jusqu'à ce que l'application la lise.
Aucun préfixe, suffixe ENTER L'application reçoit la touche de fin une fois et stocke la charge utile sans caractère de terminaison.
Aucun préfixe, suffixe TAB Le focus peut passer au contrôle suivant. L'application lit la valeur avant ce déplacement.
Préfixe imprimable personnalisé Les caractères du préfixe apparaissent avant les données décodées. L'application garde ou retire exactement ce préfixe, de façon voulue.
Suffixe imprimable personnalisé Les caractères du suffixe apparaissent après les données décodées. Entrée et Tabulation sont des touches, donc elles n'apparaissent pas dans la chaîne.
Séquence CRLF Un hôte série ou terminal traite les octets CR et LF configurés. Un champ de texte du navigateur ne gagne pas ces octets à partir d'une pression sur Entrée.

Exécutez les lignes clavier sur le lecteur en émulation et, en l'absence de matériel, avec les réglages ENTER, TAB et aucun suffixe de l'émulateur. Exécutez la ligne CRLF sur l'interface qui est censée porter ces octets. Les résultats réels dépendent encore de cette interface et de l'application.