Concevoir un protocole d'équipement sur BLE et USB

EN BREF : Mettez le protocole de l’équipement par écrit avant de développer l’un ou l’autre côté : correspondance avec le transport, format de trame, types de messages, gestion des versions, codes d’erreur et timeouts. Gardez le protocole applicatif indépendant de BLE ou d’USB pour pouvoir le tester sur une liaison série. Une spécification commune et un banc de test côté hôte permettent aux équipes firmware et application de travailler en parallèle et de repérer tôt leurs désaccords.

Schéma en couches d'un protocole d'équipement : l'application du téléphone ou du PC passe par une bibliothèque de protocole vers un adaptateur de transport BLE GATT ou USB CDC ou HID, qui rejoint le driver de transport de l'équipement, un analyseur de trames, un répartiteur de commandes et l'application de l'équipement. Un banc de test côté hôte se branche au niveau de la trame.
Figure 1. Couches du protocole. Le transport change ; les couches trame et messages, non.

1.0 Là où les protocoles d’équipement dérapent

La plupart des problèmes de protocole ne tiennent pas à BLE ou à USB en tant que tels. Ils viennent d’une interface jamais écrite. L’ingénieur firmware choisit une disposition d’octets, le développeur de l’application la déduit d’un log, et les deux divergent. Dès la deuxième version du firmware, personne ne sait quel côté a raison, une mise à jour casse la version de l’application déjà publiée sur le store, et la correction impose une livraison coordonnée des deux côtés.

La spécification couvre les transports, la trame, la table des messages, la table des erreurs et les timeouts. Écrivez-la avant la première capture au sniffer, pas après.

2.0 Découpage en couches

Nous découpons le protocole en couches pour pouvoir tester chacune séparément :

CoucheRôleChange quand
TransportAcheminer des octets : caractéristiques BLE GATT, USB CDC-ACM, rapports USB HID, UARTLe matériel ou l’OS change
TramageLimites des messages, longueur, contrôle d’intégrité, numéro de séquenceRarement
MessagesTypes de commandes et de réponses, encodage de la charge utile, codes d’erreurDe nouvelles fonctions arrivent
ApplicationCe que l’équipement fait d’une commandeLe comportement du produit change

Les couches tramage et messages ne doivent pas savoir quel transport se trouve dessous. Le même protocole peut alors passer par une UART au banc, par un adaptateur USB-série en test de production et par BLE dans le produit.

3.0 Choisir le transport

BesoinBLEUSB CDC-ACM (port série virtuel)USB HID
Sans fil vers un téléphoneUsage naturelSans objetSans objet
Sans driver sur les OS de bureauNécessite la pile Bluetooth de l’OSDriver intégré sous Windows 10 et versions ultérieures, macOS et LinuxSans driver
Accès depuis le navigateurWeb Bluetooth là où il est pris en chargeWeb Serial là où il est pris en chargeWebHID là où il est pris en charge
DébitLimité par l’intervalle de connexion et la MTUPlus élevéLimité par la taille des rapports et le polling
ConsommationConçu pour la basse consommationL’équipement peut tirer son alimentation du bus quand il est connectéComme CDC

La prise en charge de Web Bluetooth, Web Serial et WebHID varie selon le navigateur et la plateforme ; vérifiez l’état actuel pour les navigateurs de vos utilisateurs avant de vous appuyer dessus. Beaucoup de produits utilisent les deux : BLE pour l’application mobile, USB pour la configuration, le test en production et la récupération.

3.1 Correspondance avec BLE GATT

Deux approches courantes :

  • Un attribut par valeur. Chaque réglage ou mesure est une caractéristique distincte. Facile à inspecter avec des outils BLE génériques, mais chaque nouvelle fonction modifie la table GATT, et les mises à jour de plusieurs champs ne sont pas atomiques.
  • Canal de messages. Une caractéristique pour les écritures de l’hôte vers l’équipement, une pour les notifications de l’équipement vers l’hôte, qui transportent des messages tramés. Un seul protocole pour toutes les fonctions ; la table GATT ne bouge plus.

Dès que l’équipement expose plus de quelques valeurs, nous utilisons un canal de messages, et nous gardons les services standard (Device Information, Battery) sous forme d’attributs pour que les outils génériques fonctionnent toujours. Les services propriétaires exigent des UUID 128 bits ; les UUID standard figurent dans la liste Assigned Numbers du Bluetooth SIG.

Débit et latence dépendent des paramètres de connexion et de la MTU ATT négociée, que le téléphone contrôle davantage que l’équipement. Concevez le protocole pour qu’un message puisse s’étaler sur plusieurs notifications et être réassemblé, sans supposer une MTU particulière.

3.2 Correspondance avec USB

CDC-ACM apparaît comme un port série côté hôte et convient à un protocole en flux d’octets avec tramage. HID fournit des rapports de taille fixe et fonctionne sans driver, ce qui aide sur les PC d’entreprise verrouillés ; la couche de tramage répartit alors les messages sur plusieurs rapports. L’USB-IF publie les spécifications des deux classes.

4.0 La trame

Le format de trame dont nous partons :

ChampTailleRemarques
Marqueur de début ou préfixe de longueur1–2 octetsPréfixe de longueur sur BLE/HID ; délimitation de type COBS ou SLIP sur les flux d’octets
Version du protocole1 octetVersion majeure du format de trame
Numéro de séquence1–2 octetsAssocie réponses et requêtes ; détecte les pertes
Type de message1–2 octetsCommande, réponse, événement, erreur
Longueur de la charge utile2 octetsExplicite, même si le transport porte aussi une longueur
Charge utilevariableEncodage choisi par projet (structures fixes, TLV, CBOR, protobuf)
Contrôle d’intégrité2–4 octetsCRC sur les flux d’octets ; peut être omis si le transport contrôle déjà

L’encodage de la charge utile est un compromis entre taille du code sur l’équipement et souplesse. Les structures fixes little-endian sont les plus compactes et les plus difficiles à faire évoluer. TLV ou CBOR permettent d’ajouter des champs optionnels sans casser les anciens lecteurs.

5.0 Versions et compatibilité

Écrivez la règle de compatibilité. La nôtre :

  1. L’équipement renvoie sa version de protocole et ses indicateurs de fonctions en réponse à une commande « hello » ou « get info », dont la forme ne change jamais.
  2. Les nouveaux champs sont ajoutés comme optionnels. Les lecteurs ignorent les champs qu’ils ne connaissent pas.
  3. Supprimer un champ ou en changer le sens impose une nouvelle version majeure, et l’application garde la prise en charge de la version majeure précédente pendant une durée documentée.
  4. Les notes de version du firmware et de l’application indiquent les versions de protocole prises en charge.

6.0 Erreurs, timeouts et états

Chaque commande reçoit exactement une réponse : un succès avec données, ou un code d’erreur tiré d’une table documentée. Les classes d’erreur habituelles sont trame mal formée, commande inconnue, paramètre invalide, occupé, interdit dans l’état courant et défaillance interne. La table a sa place dans la spécification, pas seulement dans le code.

Les timeouts font aussi partie du protocole. Fixez le temps de réponse maximal par classe de commande, ce que fait l’hôte en cas de timeout (renvoi avec le même numéro de séquence ou abandon) et combien de temps l’équipement attend la suite d’un message en plusieurs parties avant de le rejeter.

Les opérations longues, comme une mise à jour firmware ou une calibration, doivent répondre immédiatement « accepté » et signaler leur progression par des événements, plutôt que de bloquer la réponse.

7.0 Sécurité

L’appairage et le bonding BLE protègent la liaison, mais ne décident pas de ce qu’un pair authentifié a le droit de faire. Listez les commandes qui modifient l’état, celles qui exigent une session autorisée et celles qui peuvent être exposées sans risque à tout hôte connecté. Les commandes d’usine et de débogage doivent être désactivées ou verrouillées dans le firmware de production, et la spécification doit dire comment.

8.0 Banc de test

Nous écrivons un petit outil côté hôte, en Python sauf contrainte du projet, qui parle le protocole sur un port série. Il a trois usages : permettre à l’ingénieur firmware d’essayer les commandes avant que l’application existe, exécuter en CI des tests de non-régression scriptés contre une carte au banc, et fournir à l’équipe applicative une implémentation de référence pour comparer. Soumettre l’analyseur de trames à du fuzzing avec des entrées mal formées depuis le même outil révèle une catégorie de plantages que l’usage normal n’atteint jamais.

9.0 Livrables de transfert

  • Spécification du protocole : transports, trame, table des messages, table des erreurs, timeouts, règles de version.
  • Table GATT ou descripteurs USB.
  • Outil de test côté hôte et ses scripts.
  • Une session d’exemple capturée pour chaque commande.

La page Firmware embarqué décrit le côté équipement de ce travail, et Web, cloud et gestion des équipements traite des applications et back-ends qui dialoguent avec les équipements. Pour faire relire un protocole existant, passez par le formulaire Parler de votre projet.

Références

Questions fréquentes

Profil BLE standard ou service propriétaire ?

Prenez un service standard quand il correspond aux données, comme Battery ou Device Information, car les outils génériques et les systèmes d'exploitation le comprennent. Les fonctions propres au produit demandent un service propriétaire. Un service unique de type canal de messages garde cette partie stable à mesure que des fonctions s'ajoutent.

Quel encodage choisir pour la charge utile ?

Décidez selon le budget flash et RAM de l'équipement et la fréquence à laquelle le protocole devrait évoluer. Des structures fixes conviennent à des jeux de commandes petits et stables. TLV ou CBOR coûtent plus de code mais permettent d'ajouter des champs sans casser les anciennes applications.

Comment garder les anciennes applications fonctionnelles après une mise à jour firmware ?

La commande de lecture de version ne change jamais, les nouveaux champs sont optionnels et les lecteurs ignorent les champs inconnus. Les changements incompatibles passent dans une nouvelle version majeure, et l'ancienne reste prise en charge pendant une durée inscrite dans les notes de version des deux côtés.

Un même protocole peut-il passer par BLE et par USB ?

C'est précisément la raison pour laquelle trames et messages restent indépendants du transport. Seul l'adaptateur de transport change. Les outils de test en production et de récupération peuvent ainsi utiliser un câble pendant que l'application produit passe par BLE.

Quand faut-il écrire le protocole ?

Avant que le travail firmware et applicatif ne démarre vraiment. Une première version peut être courte : transports, trame, cinq ou six commandes et la table des erreurs. Ensuite, elle évolue par relecture et non par débogage.