Utilisation de TComPort sous Delphi 2005 ( Win 32 )

Date de publication : 17/02/2005 , Date de mise a jour : 07/06/2005

Par Nono40 (nono40.developpez.com)
 

Utilisation des composants TComPort sous Delphi 2005.
Principes de base d'utilisations de ces composants

I. Introduction

Ces composants peuvent être téléchargés ici :  Comport Library

Ce document est prévu pour les versions Pro, Entreprise et Architecte. Pour la version Personnel veuillez lire ceci en premier.

II. Installation des composants

II-A. Installation du paquet d'exécution

II-B. Installation du paquet de conception

{$IFDEF VER170}     { Delphi 2005 }
  {$DEFINE DELPHI_4_OR_HIGHER}
  {$DEFINE DELPHI_5_OR_HIGHER}
  {$DEFINE DELPHI_6_OR_HIGHER}
  {$DEFINE DELPHI_7_OR_HIGHER}
  {$DEFINE DELPHI_2005_OR_HIGHER}
  {$DEFINE DELPHI_2005}
  {$IFDEF BCBNOTDELPHI}
    {$ObjExportAll On}
  {$ENDIF}
  {$WARN UNSAFE_TYPE OFF}
  {$WARN UNSAFE_CODE OFF}
  {$WARN UNSAFE_CAST OFF}
{$ENDIF}

II-C. Ajouter le chemin dans les options

III. Présentation des composants ComPort

• TComPort : composant d'accès au port série lui-même.
• TComDataPacket : Composant de gestion de trames reçues.
• TComComboBox : Composant visuel d'aide à la configuration du TComport
• TComRadioGroup : Composant visuel d'aide à la configuration du TComport
• TComLed : Composant permettant de visualiser l'activité du composant ComPort associé
• TComTerminal : Composant de visualisation des trames de la liaison série

III-A. TComPort

• Propriété Port
  Cette propriété définit le port à utiliser sur le PC. Dans la liste déroulante seuls les ports existant physiquement apparaissent.
  Notez que ComPort est basé sur les APIs Windows, donc il supporte parfaitement les drivers passerelle, style USB--RS232.
• Propriété BaudRate
  Définit la vitesse de la liaison série en Bauds.
• Propriété DataBits
  Définit le nombre de bits de chaque caractère émis/reçu sur la liaison série.
• Propriété Parity
  Définit la type de bit de parité de chaque caractère. Il est possible ici de définir si le contrôle de parité doit être effectué en lecture, et dans le cas où il est effectué de remplacer dans la trame reçue les caractères ayant un défaut de parité par un caractère spécifique.
  Pour les essais, je vous conseille de ne pas activer le contrôle de parité, il n'est pas indispensable au bon fonctionnement et peut facilement être ajouté par la suite si vous voulez renforcer le contrôle.
  De toute manière, dans le cas d'envoi/réception de trames il est préférable de gérer un checksum plus évolué de style CRC.
• Propriété StopsBits
  Nombre de bits de stops de chaque caractère.
• Propriété FlowControl
  Cet ensemble de propriétés permet de définir la gestion du flux de caractères sur la liaison série.
  Par expérience et dans la mesure du possible il est préférable de ne pas utiliser le contrôle de flux, car cela ne fait que compliquer le gestion et le cablâge de la liaison. Il y a cependant des exceptions, comme la gestion d'un modem ou la gestion d'un convertisseur RS232-RS485 multipoints.
  Dans les premiers exemples donnés dans ce cours, aucun contrôle de flux ne sera utilisé.
• Propriété Timeouts
  Cet ensemble de propriétés permet de définir les différents timeouts en émission et en réception. Leur utilisation dépend des applications.
• Propriété Events
  Permet de définir quels événements liés à l'activité de la liaison série sont utilisés.
  Par défaut ils sont tous activés, mais vous pouvez supprimer tous ceux qui ne vous sont pas utiles afin de ne pas surcharger le dialogue avec le TComport.
• Propriété EventChar
  Cette propriété permet de définir le caractère déclenchant OnRxChar quand il est reçu. Il faut bien sur que l'événement soit activé dans la propriété Events.
• Propriété Connected
  Cette propriété permet d'ouvrir/fermer la liaison série et aussi d'en vérifier son état.

III-B. TComDataPacket

• Propriété Port
  Permet de choisir à quel composant TComPort celui-ci doit être associé.
  Cette propriété doit impérativement être définie.
• Propriété Size
  Longueur de la trame à recevoir, si la longueur n'est pas fixe, positionner cette propriété à zéro.
• Propriété StartString
  Chaîne définissant le début de la trame.
• Propriété StopString
  Chaîne définissant la fin de la trame.
• Propriété CaseInsensitive
  Permet de choisir la sensibilité à la casse sur les caractères reçus.
• Propriété IncludeStrings
  Permet de définir si les chaînes StartString et StopString doivent être incluses dans la trame ou non.

III-C. TComComboBox et TComRadioGroup

• Propriété ComPort
  Permet de choisir à quel composant TComPort celui-ci doit être associé.
  Cette propriété doit impérativement être définie.
• Propriété ComProperty
  Permet de définir quel paramètre de la liaison sera affecté par le composant. Comme par exemple la vitesse, la parité, etc.
• Propriété AutoApply
  Permet de définir si les modifications apportées dans la sélection sont automatiquement portées sur la configuration de la liaison.
  Si cette propriété est à True, tout changement sera directement reporté dans la configuration du port série du TComport associé.
  Si cette propriété est à False, il faut appeler par code la méthode ApplySettings de ce composant pour que les modifications soient effectives.

III-D. TComLed

• Propriété ComPort
  Permet de choisir à quel composant TComPort celui-ci doit être associé.
  Cette propriété doit impérativement être définie.
• Propriété King
  Permet de définir le type de dessin du composant. Dans le cas de lkCustom, vous devez donner des images pour les états ON et OFF dans les propriétés GlyphON et GlyphOFF.
• Propriété LedSignal
  Permet d'associer le composant à un état particulier de la liaison série.
• Propriété State
  Permet de définir, mais surtout de connaître l'état ON/OFF du composant. Quand la liaison est active, cette propriété est en lecture seule.

III-E. TComTerminal

• Propriété ComPort
  Permet de choisir à quel composant TComPort celui-ci doit être associé.
  Cette propriété doit impérativement être définie.
• Propriété WrapLines
  Définit si le retour à la ligne est automatique en cas de dépassement sur la droite.
• Propriété LocalEcho
  Définit si les caractères tapés au clavier sont aussi affichés sur la console.
• Propriété SendLF
  Définit si l'envoi d'un retour chariot (touche entrée, caractère #13) doit être suivit d'un caractère saut de ligne (Line-Feed, #10).
• Propriété AppendLF
  Définit si la réception d'un retour chariot (caractère #13) doit être interprétée comme un caractère composé CR LF (ajout d'un LF, #10).
• Propriété Force7bit
  Force l'émission/réception de caractères sur 7 bits seulement. Tous les caractères étendus (8 bits) seront réduits à 7.
• Propriétés Columns et Rows
  Définissent la taille en caractères de la console.
• Propriété Connected
  Est équivalente à la propriété Connected du composant ComPort associé. La modification de l'une entraîne la modification de l'autre.
• Propriété Caret
  Définit la forme du caret de la console.
• Propriété Emulation
  Définit le type d'émulation de la console dans le cas de réception d'une séquence d'échappement.
  Cette propriété est surtout utile dans le cas d'utilisation de ce composant en remplacement d'une console ASCII.
• Propriété ArrowsKeys
  Définit si les touches de directions doivent être envoyés sous forme de caractère (akTerminal) ou utilisées pour déplacer le caret (akWindows).

IV. Applications

IV-A. Un terminal simple

  Comport1.Connected := Not Comport1.Connected;

IV-B. Envoyer et recevoir des caractères avec le TComPort

procedure TForm1.ComPort1AfterOpen(Sender: TObject);
begin
  btnEnvoyer.Enabled := True;
  btnConnecter.Enabled := False;
end;

procedure TForm1.ComPort1RxChar(Sender: TObject; Count: Integer);
Var Chaine:String;
begin
  ComPort1.ReadStr(Chaine,Count);
  Memo1.Lines.Text := Memo1.Lines.Text + Chaine;
end;

procedure TForm1.btnEnvoyerClick(Sender: TObject);
begin
  If eCRLF.Checked
    Then ComPort1.WriteStr(eEnvoi.Text+#13#10)
    Else ComPort1.WriteStr(eEnvoi.Text);
end;

Les procédures utilisées (ReadStr et WriteStr) sont bloquantes, c'est-à-dire que l'exécution ne reprend qu'après l'envoi/réception du nombre de caractères voulus.

IV-C. Synchrone / Asynchrone

IV-C-1. Envoi synchrone

procedure TForm1.btnEnvoyerSyncClick(Sender: TObject);
begin
  btnEnvoyerSync.Enabled := False;
  ComPort1.WriteStr(eEnvoiSync.Text);
  btnEnvoyerSync.Enabled := True;
end;

IV-C-2. Envoi asynchrone

Var
  // Structure de trace de l'envoi
  WriteASyncPtr:PAsync = Nil;

procedure TForm1.btnEnvoyerASyncClick(Sender: TObject);
begin
  btnEnvoyerASync.Enabled := False;
  // Mise à jour de la structure d'envoi
  InitAsync(WriteAsyncPtr);
  // Envoi différé
  ComPort1.WriteStrAsync(eEnvoiSync.Text,WriteAsyncPtr);
end;

procedure TForm1.ComPort1TxEmpty(Sender: TObject);
begin
  // Quand la file d'envoi est vide on teste si un envoi est en cours
  If Assigned(WriteAsyncPtr) Then
  Begin
    // On supprime la structure de trace
    DoneAsync(WriteAsyncPtr);
    btnEnvoyerASync.Enabled := True;
  End;
end;

IV-C-3. Réception synchrone

procedure TForm1.btnRecevoirSyncClick(Sender: TObject);
Var
  Chaine:String;
  Long:Integer;
begin
  // MAJ composants
  btnRecevoirSync.Enabled := False;
  Memo1.Lines.Add('Début envoi synchrone');
  // Mise à jour du time out demandé
  Comport1.Timeouts.ReadTotalConstant := seTimeOut.Value * 1000;
  // Supression de ce qui traine dans le buffer d'entrée
  Comport1.ClearBuffer(True,False);
  // Lecture bloquante de la longueur demandée
  Long:=Comport1.ReadStr(Chaine,seLongueur.Value);
  // MAJ composants
  Memo1.Lines.Add('Fin envoi synchrone '+IntToStr(Long)+' caractère(s) reçu(s):'+Chaine);
  btnRecevoirSync.Enabled := True;
end;

IV-C-4. Réception asynchrone

Var
  ReadASyncPtr:PAsync = Nil;

procedure TForm1.btnRecevoirAsyncClick(Sender: TObject);
Var
  Chaine:String;
  Long:Integer;
begin
  // MAJ composants
  btnRecevoirASync.Enabled := False;
  Memo1.Lines.Add('Début envoi asynchrone');
  // Mise à jour du time out demandé
  Comport1.Timeouts.ReadTotalConstant := seTimeOut.Value * 1000;
  // Supression de ce qui traine dans le buffer d'entrée
  Comport1.ClearBuffer(True,False);
  // Init de la structure de suivi
  InitAsync(ReadAsyncPtr);
  Try
    // Lecture non-bloquante de la longueur demandée
    // Attention, la chaine doit rester accessible hors de l'événement...
    Chaine:='';
    Comport1.ReadStrAsync(Chaine,seLongueur.Value,ReadAsyncPtr);
    Repeat
      // Ici on n'est pas bloqué, on peut donc traiter les messages Windows
      Application.ProcessMessages;
      // Attente de la fin de traitement
    Until Comport1.IsAsyncCompleted(ReadAsyncPtr);
    // récupération du résultat de la lecture de la chaine
    Long:= Comport1.WaitForAsync(ReadAsyncPtr);
    SetLength(Chaine,Long);
  Finally
    DoneAsync(ReadAsyncPtr);
  End;
  // MAJ composants
  Memo1.Lines.Add('Fin envoi asynchrone '+IntToStr(Long)+' caractère(s) reçu(s):'+Chaine);
  btnRecevoirASync.Enabled := True;
end;

IV-D. Réception de trames avec TComDataPacket

V. Conclusion

Tests et outils

Outil : Les nouveautés de Delphi 2009

Outil : Test de QuickReport 4 Professionnel

Voir également mes autres articles :

Utiliser Delphi 2005 comme éditeur HTML

Utilisation du correcteur orthographique de Word dans Delphi.

Utiliser l'assembleur en ligne avec Delphi

Utilisation de la propriété TBitmap.ScanLine

Utilisation de TComPort sous Delphi 2005 ( Win 32 )

Installation des composants SynEdit sous Delphi 2005 ( Win 32 )

Réalisation d'un écran de veille avec Delphi

Article sur les automates programmables

Configurer un variateur ATV71 sur un réseau Profibus avec PL7

Articles sur Delphi pour .NET

Conversion des pointeurs d'enregistrement sous Delphi .NET

Utilisation des fichiers typés sous Delphi .NET

Utilisation de la classe NotifyIcon dans Delphi .NET

Création d'un contrôle Winform avec Delphi .NET

Programmation réseau avec Delphi pour .NET

Consultez aussi les sources Delphi :

Les sources de Nono40