Skip to main content
Version : Suivante

SerialStream

Haply::HardwareAPI::IO::SerialStream

Fournit un flux compatible avec std::iostream pour un port série.

A utiliser en conjonction avec les classes Inverse3 et les classes Handle. L'API fournit la classe DeviceDetection pour trouver facilement les ports série qui sont actuellement associés à un appareil Haply .

OpenDevice ou en passant true au paramètre SerialStream est nécessaire pour que l'objet puisse être utilisé avec l'une des classes de périphériques.

Index​

Méthodes​

NomTypeDescription
SerialStream(const char *, bool)Construit un objet SerialStream à partir de ...
~SerialStream()Ferme le port série et libère les ressources associées.
Dispositif ouvertchar()Ouvre le port série pour le rendre utilisable par l'un des périphériques ...
CloseDevicevoid()Cette fonction ferme le port série.
Disponibleint()Cette fonction renvoie le nombre d'octets disponibles pour la lecture ...
WriteBytesvoid(const char *, size_t)Cette fonction écrit les données données sur le port série.

Méthodes​

SerialStream​

SerialStream( const char * port, bool open)

Construit un objet SerialStream à partir du port série donné.

AVERTISSEMENT Si open est passé comme et qu'une erreur est soulevée lors de l'ouverture du port, une erreur sera écrite sur stderr et l'objet résultant ne sera pas valide.

Paramètres​

  • port Le port série à ouvrir. Sous Windows, les ports série supérieurs à 9 doivent être préfixés par pour être valides. Par exemple, ou doit être utilisé pour ouvrir le port série .

  • open Si vrai, Opendevice sera appelé dans le constructeur.

~SerialStream​

~SerialStream()

Ferme le port série et libère les ressources associées.

Dispositif ouvert​

char OpenDevice()

Ouvre le port série pour le rendre utilisable par l'une des classes de périphériques.

Retours​

Renvoie la valeur zéro si le port a été ouvert avec succès. Renvoie une valeur négative si le port série n'a pas pu être ouvert et une erreur sera imprimée sur stderr.

CloseDevice​

void CloseDevice()

Cette fonction ferme le port série.

Appelé par le destructeur et peut être ignoré dans la plupart des cas.

Disponible​

int Available()

Cette fonction renvoie le nombre d'octets disponibles pour la lecture sur le port série.

Retours​

Nombre d'octets disponibles pour la lecture sur le port série.

WriteBytes​

void WriteBytes( const char * data, size_t size)

Cette fonction écrit les données données sur le port série.

Paramètres​

  • data Données à écrire sur le port série.

  • size Taille des données à écrire sur le port série.