Composant de port série

Ouvre des ports RS-232 et RS-485 depuis Delphi, C++Builder et .NET. Configure la ligne, écris des données et reçois-les dans un événement ou par des lectures bloquantes, sous Windows, Linux et macOS.

Nouveau

TsgcSerialPort

Un port série avec un thread de lecture en arrière-plan, un tampon de réception de 64 Ko et la même API en Delphi, C++Builder et C#. C'est aussi le transport du client et du serveur Modbus RTU.

Classe de composant

TsgcSerialPort

Interfaces

RS-232, RS-485 et adaptateurs série USB

Plateformes

Windows, Linux et macOS (pas Android ni iOS)

Édition

Inclus dans sgcWebSockets Enterprise (Delphi et .NET) et All-Access, ou dans le pack autonome sgcIndustrial

Ouvrir un port et recevoir des données

Indique le nom du port et les paramètres de ligne, affecte les événements et appelle Open. OnData reçoit chaque bloc d'octets dès son arrivée.

uses
  sgcIndustrial;

procedure TForm1.OpenPort;
begin
  FPort := TsgcSerialPort.Create(Self);
  FPort.Port := 'COM3';
  FPort.BaudRate := 19200;
  FPort.DataBits := 8;
  FPort.Parity := spEven;
  FPort.StopBits := ssOne;
  FPort.OnData := OnSerialData;
  FPort.OnError := OnSerialError;
  FPort.Open;
  FPort.WriteString('AT' + #13);
end;

procedure TForm1.OnSerialData(Sender: TObject; const aData: TBytes);
begin
  // queued to the main thread by default (NotifyEvents = neAsynchronous)
  Memo1.Lines.Add(IntToStr(Length(aData)) + ' bytes received');
end;

procedure TForm1.OnSerialError(Sender: TObject; const aError: string);
begin
  Memo1.Lines.Add('Error: ' + aError);
end;
#include "sgcIndustrial.hpp"

void __fastcall TForm1::OpenPort()
{
  FPort = new TsgcSerialPort(this);
  FPort->Port = "COM3";
  FPort->BaudRate = 19200;
  FPort->DataBits = 8;
  FPort->Parity = spEven;
  FPort->StopBits = ssOne;
  FPort->OnData = OnSerialData;
  FPort->OnError = OnSerialError;
  FPort->Open();
  FPort->WriteString("AT\r");
}

void __fastcall TForm1::OnSerialData(TObject *Sender, const TBytes aData)
{
  // queued to the main thread by default (NotifyEvents = neAsynchronous)
  Memo1->Lines->Add(IntToStr(aData.Length) + " bytes received");
}

void __fastcall TForm1::OnSerialError(TObject *Sender, const String aError)
{
  Memo1->Lines->Add("Error: " + aError);
}
using System;
using esegece.sgcWebSockets;

class SerialTerminal
{
    TsgcSerialPort FPort = new TsgcSerialPort();

    public void OpenPort()
    {
        FPort.Port = "COM3";
        FPort.BaudRate = 19200;
        FPort.DataBits = 8;
        FPort.Parity = TsgcSerialParity.spEven;
        FPort.StopBits = TsgcSerialStopBits.ssOne;
        FPort.OnData += OnSerialData;
        FPort.OnError += OnSerialError;
        FPort.Open();
        FPort.WriteString("AT\r");
    }

    void OnSerialData(object Sender, byte[] aData)
    {
        Console.WriteLine(aData.Length + " bytes received");
    }

    void OnSerialError(object Sender, string aError)
    {
        Console.WriteLine("Error: " + aError);
    }
}

Sous le capot

Un port série complet pour les instruments, les modems, les lecteurs de codes-barres, les balances et les bus de terrain.

Paramètres de ligne

BaudRate, DataBits (5 à 8), Parity (none, odd, even, mark, space), StopBits (1, 1.5, 2) et FlowControl (RTS/CTS ou XON/XOFF). Les combinaisons invalides lèvent EsgcSerialError à l'ouverture du port.

Événements ou lectures bloquantes

Avec OnData affecté, chaque bloc d'octets va à l'événement. Sans lui, les octets attendent dans un tampon de 64 Ko et Read renvoie une réponse complète : il attend le premier octet et s'arrête après un silence que tu choisis.

Contrôle de direction RS-485

Mets RtsControl à srcToggle pour les adaptateurs qui changent de direction avec RTS. Sous Windows, le pilote active RTS pendant l'émission, et sous Linux le mode RS-485 du noyau est activé. En .NET, la bascule est cadencée par le composant.

Ports et lignes modem

TsgcSerialPort.ListPorts liste les ports dans l'ordre naturel (COM2 avant COM10). SetDTR, SetRTS et ModemStatus pilotent et lisent les lignes modem.

Thread-safe

Write peut être appelé depuis n'importe quel thread. Close fonctionne depuis n'importe quel thread, y compris depuis un gestionnaire d'événement, et réveille un Read bloqué. En Delphi et C++Builder, les événements sont placés par défaut dans la file du thread principal, et NotifyEvents modifie ce comportement.

Erreurs claires

Chaque échec lève EsgcSerialError, dont ErrorCode contient le code d'erreur du système d'exploitation lorsque celui-ci en a signalé un. Un appareil débranché alors que le port est ouvert, ou un tampon de réception plein, déclenche OnError.

Envoyer une commande, lire la réponse

Laisse OnData vide, écris la commande et appelle Read : il attend jusqu'à 1000 ms le premier octet et revient lorsque l'appareil est resté silencieux pendant 50 ms.

procedure TForm1.QueryDevice;
var
  vData: TBytes;
  vCount: Integer;
begin
  // OnData is not assigned: the bytes wait in the receive buffer for Read
  FPort.Purge;
  FPort.WriteString('*IDN?' + #10);
  // wait up to 1000 ms for the first byte, the reply ends after 50 ms of silence
  vCount := FPort.Read(vData, 256, 1000, 50);
  if vCount = 0 then
    Memo1.Lines.Add('No reply')
  else
    Memo1.Lines.Add(IntToStr(vCount) + ' bytes read');
end;
void __fastcall TForm1::QueryDevice()
{
  // OnData is not assigned: the bytes wait in the receive buffer for Read
  FPort->Purge();
  FPort->WriteString("*IDN?\n");
  // wait up to 1000 ms for the first byte, the reply ends after 50 ms of silence
  TBytes vData;
  int vCount = FPort->Read(vData, 256, 1000, 50);
  if (vCount == 0)
    Memo1->Lines->Add("No reply");
  else
    Memo1->Lines->Add(IntToStr(vCount) + " bytes read");
}
using System;
using esegece.sgcWebSockets;

class SerialQuery
{
    TsgcSerialPort FPort = new TsgcSerialPort();

    public void QueryDevice()
    {
        // OnData is not assigned: the bytes wait in the receive buffer for Read
        FPort.Port = "COM3";
        FPort.Open();
        FPort.Purge();
        FPort.WriteString("*IDN?\n");
        // wait up to 1000 ms for the first byte, the reply ends after 50 ms of silence
        byte[] vData = FPort.Read(256, 1000, 50);
        if (vData.Length == 0)
            Console.WriteLine("No reply");
        else
            Console.WriteLine(vData.Length + " bytes read");
    }
}

Spécifications et références

Les interfaces du système d'exploitation sur lesquelles ce composant est construit.

Questions sur le port série

En Delphi et C++Builder, il fonctionne sous Windows (Win32 et Win64) avec l'API de communications Win32, et sous Linux64 et macOS avec POSIX termios. Il n'est pas disponible sous Android ni iOS. La version .NET repose sur System.IO.Ports.

Utilise OnData pour les appareils qui envoient des données d'eux-mêmes, comme un lecteur de codes-barres ou une balance. Utilise Read pour les protocoles requête et réponse : envoie la commande, puis lis jusqu'à ce que l'appareil cesse d'envoyer. Les deux sont exclusifs : Read lève EsgcSerialError tant que OnData est affecté, et un seul thread peut appeler Read à la fois.

Un adaptateur qui change automatiquement de direction n'a besoin d'aucun réglage. Un adaptateur qui change de direction avec la ligne RTS demande de mettre RtsControl à srcToggle. Sous Linux, le composant active alors le mode RS-485 du pilote et lève EsgcSerialError lorsque le pilote ne le prend pas en charge. macOS ne prend pas en charge srcToggle.

Il est inclus dans sgcWebSockets Enterprise (Delphi et .NET) et All-Access, dans le cadre du pack sgcIndustrial. En Delphi, ajoute sgcIndustrial à la clause uses.

Documentation et démos

Accède directement à la référence du composant, ouvre le projet de démo et lis le document technique.

Online Help: TsgcSerialPort Référence complète des propriétés, méthodes et événements de ce composant.
Projet de démo : Industrial\01.Serial_Port Un terminal série pour Delphi, C++Builder et .NET. Il est livré dans le paquet sgcWebSockets.
Document technique (PDF) Fonctionnalités, démarrage rapide, exemples de code et références de sources primaires pour ce seul composant.
Manuel utilisateur (PDF) Manuel complet couvrant tous les composants de la bibliothèque.
Meilleur rapport qualité-prix : All-AccessTous les produits eSeGeCe, Support Premium inclus, à partir de €1,059/an.
Voir les tarifs All-Access

Inclus dans sgcWebSockets Enterprise

Inclus dans sgcWebSockets Enterprise (Delphi et .NET) et All-Access, ou dans le pack autonome sgcIndustrial.