RS232, protocole mystère et ingénierie inverse

On a récemment acheté un agitateur magnétique chauffant contrôlable à distance grâce à un port RS232. Malheureusement le fabriquant a semble-t-il oublié de documenter le protocole de communication et quand on s'en est aperçu il était trop tard. Pas grave, c'est l'occasion idéale de vous montrer comment contourner le problème avec un Yocto-RS232.




Un agiteur chauffant magnétique est, en gros, une plaque chauffante capable de touiller toute seule à l'aide d'un aimant qu'elle fait tourner dans le récipient qu'elle chauffe.

L'agiteur fait tourner un aimant dans le liquide pour le mélanger.

L'agitateur en question est un AG802 vendu sous la marque LMR. Cependant, une rapide recherche sur internet permet d'établir qu'il s'agit en fait d'un modèle générique vendu sous différentes marques mais fabriqué par DragonLab instruments sous la référence MS-H-Pro.

L'agiteur MS-H-Pro de DragonLab, a.k.a. AG802

On a donc acheté cet agitateur bon marché pour son port RS232, Pas de chance, le mode d'emploi ne décrit pas le protocole utilisé pour contrôler l'agitateur et le revendeur a été incapable de nous aider. On a bien essayé de contacter DragonLab pour leur demander des précisions, mais ils n'ont pas daigné répondre. En revanche une application de contrôle, StirrerPC est fournie. C'est un bon point de départ pour essayer de comprendre comment fonctionne le protocole de contrôle à l'aide d'un Yocto-RS232.

Le soft de contrôle fourni par DragonLab

Yocto-RS232 et snooping mode

Il se trouve que le Yocto-RS232 dispose d'une petite fonctionnalité intéressante: il peut fonctionner en mode analyseur et afficher le contenu des communications qui transitent sur un câble série. Pour cela on intercale un petit adaptateur sur la connexion, on branche le Yocto-RS232 sur cet adaptateur. On configure le Yocto-RS232 en mode snopper et le tour est joué.

L'adaptateur pour analyser les communication RS232 avec un Yocto-RS232

L'adaptateur est question est vendu tout fait par Yoctopuce sous le nom RS232-Snooping-Adapter, mais vous pouvez aussi le fabriquer vous même: il ne contient pas d'électronique. Vous trouverez le schéma de câblage dans la doc du Yocto-RS232.

Le Yocto-RS232 peut analyser une communication RS232

Une fois le Yocto-RS232 connecté, il suffit de le configurer avec le VirtualHub. Contrairement à ce qu'annonce la doc du AG802, le protocole est du binaire à 9600 bauds, 8N1 et non pas 7N1. Ne pas oublier de mettre le Yocto-RS232 en mode Snooping.

Configuration du Yocto-Rs232 en mode snooper

Une fois que tout est configuré correctement, le Yocto-RS232 enregistre dans sa mémoire interne tout ce qui passe sur le cable série. Il est possible de consulter les données enregistrées à l'aide de l'API, mais le moyen le plus rapide consiste à utiliser le VirtualHub. L'URL http://127.0.0.1:4444/bySerial/serial/rxmsg.json?dir=2 permet d'afficher le contenu complet des buffers du Yocto-RS232. Par exemple si le numéro de série du Yocto-RS232 est RS232MK1-33E7F:

http://127.0.0.1:4444/bySerial/RS232MK1-33E7F/rxmsg.json?dir=2

Décodage du protocole

Une fois que tout est en place, il suffit d'effectuer quelques actions de base avec l'application fournie par DragonLab. En modifiant un seul paramètre à chaque fois et en observant comment les données transitant sur le câble en sont affectées, on peut essayer de comprendre ce qu'il se passe.

Consignes

Par exemple si on demande a l'application de lancer l'agitateur avec la consigne 63 °C et 255 tours par minute, on observe la communication suivante:

=>FE =>B1 =>00 =>FF =>00 =>B0 <=FDB1000000B1 =>FE =>B2 =>02 =>76 =>00 =>2A <=FDB2000000B2

On remarque que l'application envoie ses commandes sous la forme de paquets de 6 bytes. On a remarqué que ces bytes sont envoyé très lentement: environ un byte toutes le 50ms. On a découvert plus tard la raison: si on essaye de les envoyer plus vite, l'agitateur plante. Après quelques essais avec des valeurs de consigne différentes, on a déterminé que les paquets ont la forme suivantes:

Les paquets pour la consigne de vitesse d'agitation sont très similaire: la commande est 0xB1 et la vitesse est encodée directement, par exemple une vitesse de 255 t/min est encodée 0x00 0xFF. L'agitateur confirme chaque commande avec un paquet de six bytes.

Apparemment , il n'y a pas de commande explicite pour arrêter l'agiteur: Lorsque qu'on clique sur le bouton stop: le soft de DragonLab se contente de répéter les dernière consignes et l'appareil s'arrête. Un choix de design un peu étrange.

Décodage des paquets de monitoring

On aussi découvert que l'application envoie à intervalle régulier des paquets qui servent à connaitre l'état de l'agitateur, ainsi on voit régulièrement passer le paquet suivant: 0xA2,0x00,0x00,0x00,0xA2 et la réponse a le format suivant:

On a aussi observé le passage d'un autre paquet 0xA1,0x00,0x00,0x00,0xA1 qui permet de connaitre les paramètres de l'agitateur. La réponse a le format suivant:

Paquets d'initialisation

On a remarqué qu'au démarrage, l'application envoie 16 paquets, [0xFE,x0A3,0x00,0xXX,0x00,checksum] avec 0xXX prennat les valeurs 0x00 puis 0x10 à 0x1F. Apparemment cela sert à récupérer une chaine de caractères contenant le modèle d'agitateur. La transaction a le format suivant:

Conclusion

Grâce au Yocto-RS232, et son mode snooping, on a pu "reverse-engineerer" le protocole série entre l'application fournie par DragonLab et l'agitateur. On va donc maintenant pouvoir écrire une petite librairie permettant de piloter l'agitateur avec un Yocto-RS232. Malgré l'absence de documentation, on a réussi à retomber sur nos pattes, mais on notera cependant que le reverse-engineering ne permet de reconstruire que les commandes que l'on peut voir passer sur le câble, il est probable que l'agitateur accepte d'autre commandes, mais il est impossible de les deviner.

Vous devez probablement vous demander ce que Yoctopuce compte faire avec un agitateur magnétique chauffant, mais ça vous le saurez la prochaine fois...