Permet de décoder les messages selon le format 'C a1 a2 a3 ...' où C est une lettre ou un mot représentant une commande donnée, suivie d'une liste d'arguments de taille et de type variable.
La librairie fonctionne avec tout objet qui implémente la classe Stream; l'objet fournira le texte brut qui sera décodé.
- Refonte du code au complet. On laisse tomber la mise en buffer des arguments, on stocke tout le message reçu dans un String et on décode les arguments seulement sur demande;
- Ajouter des méthodes refresh() pour consommer le stream et renommage de isAvailable();
- Ajout des méthodes getCommandString() et getArgString() pour permettre d'utiliser tout le texte tel quel de chaque morceau du message;
- getArg(index,base) a un second paramètre optionnel pour préciser la base pour la conversion (bases supportées de 2 à 36);
- Ajout de la méthode getMessage() pour relire le message trimé reçu;
- Ajout du paramètre "finDeMessage" pour modifier le caractère qui délimite la fin du message;
- Ajout des getters et setters pour les parametres "séparateur", "finDeMessage".
- Changé l'URL du projet pour pointer sur GitHub.
- Idem que précédent, avec un correctif pour le caractère '\n' et '\r'.
- Correction si le message reçu ne contient qu'un retour de chariot.
- Première version officielle, crée à partir de l'ancienne librairie SerieTPhys.
On utilise cette librairie pour implémenter un mode de message simplifié du type "commande arg0 arg1 arg2 ...", où "commande"" est un seul caractère ou un mot entier, et les arguments sont habituellement numériques, et peuvent se suivre sans limite théorique.
Voici des exemples de messages qui pourrait être utilisée:
"R 1 2"
"T 3.45"
"g -7.8 0 45"La librairie permet également de supporter des commandes ou des arguments sous forme de texte. Voici des exemples:
"tourner 45"
"set version 2"La librairie permet également de supporter des arguments écrits dans des bases autres, tel qu'en binaire ou en hexadécimal. Voici des exemples :
"set ff"
"Changer valeur 10111010"-
Avant le début du décodage du message, la fonction trim() est appliquée sur le texte reçu, ce qui aura pour effet de retirer tout espace blanc avant et après le message. On tentera également de retirer du message le caractère invisible \0.
-
Lors du décodage du message, deux caractères de séparation consécutifs seront interprétés comme contenant ayant un argument vide entre les deux. Par exemple, le message "g_1__2" où '_' serait le caractère séparateur, doit être vu comme étant une commande contenant trois arguments "g_1_{vide}_2". C'est donc à l'utilisateur de prendre soin du formatage de ses messages pour éviter ce genre d'arguments "fantômes".
Voici un exemple simple, avec une commande à une lettre et des arguments numériques
#include <Decodeur.h>
Decodeur monDecodeur(&Serial); //fournir un objet qui implémente la classe Stream
void setup()
{
Serial.begin(115200); //Ou tout autre instruction d'initialisation pour le port de communication
}
void loop()
{
monDecodeur.refresh(); //Pour consommer le Stream dans l'objet Décodeur.
if (monDecodeur.isAvailable()) // Si un message est disponible
{
char command = monDecodeur.getCommand(); //Obtenir le premier caractère de commande décodé
int argCount = monDecodeur.getArgCount(); //Obtenir le nombre d'arguments décodé.
for (int no = 0; no < argCount; no++) //Pour chaque argument
{
float arg = monDecodeur.getArg(no); //Obtenir l'argument d'indice 'no'
}
}
}
Voici une version avancée, pouvant utiliser une commande et des arguments textuels
#include <Decodeur.h>
Decodeur monDecodeur(&Serial); //fournir un objet qui implémente la classe Stream
void setup()
{
Serial.begin(115200); //Ou tout autre instruction d'initialisation pour le port de communication
}
void loop()
{
monDecodeur.refresh(); //Pour consommer le Stream dans l'objet Décodeur.
if (monDecodeur.isAvailable()) // Si du texte est disponible
{
String command = monDecodeur.getCommandString(); //Obtenir le mot de commande décodé
int argCount = monDecodeur.getArgCount(); //Obtenir le nombre d'arguments décodé.
for (int no = 0; no < argCount; no++) //Pour chaque argument
{
String arg = monDecodeur.getArgString(no); //Obtenir l'argument d'indice 'no' sous forme de texte
}
}
}
Decodeur(Stream *stream)
Decodeur(Stream *stream,char separateur)
Decodeur(Stream *stream,char separateur, char finDeMessage)On spécifie l'objet qui implémente la classe Stream (dans Arduino on retrouve les objets suivants: Serial, Ethernet, Wire, SD). On doit fournir l'addresse de l'objet, en ajoutant le caractère '&' devant celui-ci (voir section Utilisation).
On spécifie facultativement le caractère servant à séparer la commande et les arguments (par défaut, l'espace ' ') ainsi que le caractère servant à signifier la fin du message (par défaut '\n').
bool refresh()Cette méthode permet de consommer le Stream et mettre à jour les valeurs du décodeur. La fonction trim() est appliquée sur le texte reçu, ce qui aura pour effet de retirer tout espace blanc avant et après le message. On tentera également de retirer du message le caractère invisible \0. Cette méthode retourne le même résultat que la méthode isAvailable().
bool isAvailable()Cette méthode indique si un message a été reçu et décodé.
char getCommand()Permet de lire le caractère de commande décodé.
String getCommandString()Permet de lire tout le mot de commande décodé.
int getArgCount()Permet de lire le nombre d'arguments décodé.
float getArg(int index)
float getArg(int index, unsigned int base)Permet de lire l'argument d'index donné. Retourne 0 en cas d'indice non valide, ou si l'argument n'a pas été correctement décodé. Permet de préciser optionnellemnent la base dans laquelle l'argument a été écrit, entre 2 et 36 (par défaut en base 10). On utilise fréquemment la base binaire 2 (ou mot-clé BIN avec Arduino) ou la base hexadécimale 16 (ou mot-clé HEX).
String getArgString(int index)Permet de lire l'argument d'index donné, sous forme de String. Retourne une chaîne vide "" en cas d'indice non valide.
void setSeparateur(char value);
char getSeparateur();Permet de lire et écrire le caractère pour séparer les arguments du message.
void setFinDeMessage(char value);
char getFinDeMessage();Permet de lire et écrire le caractère marquant la fin du message.