Serial Klassenreferenz

Serielle Schnittstelle. Mehr ...

#include <serial.h>

Klassendiagramm für Serial:

Öffentliche Typen
enum	comPort
	COM-Port. Mehr ...
enum	baudRate
	Übertragungsgeschwindigkeit. Mehr ...
enum	dataBits
	Anzahl der Datenbits pro Zeichen.
enum	stopBits
	Anzahl der Stopbits pro Zeichen.
enum	parity
	Paritätsbit.

Öffentliche Methoden
	Serial (Serial::comPort port=COM1, Serial::baudRate baudrate=BAUD_115200, Serial::dataBits databits=DATA_8BIT, Serial::stopBits stopbits=STOP_1BIT, Serial::parity parity=PARITY_NONE)
	Konstruktor. Mehr ...
int	read (bool blocking=true)
	Lese ein Byte von serieller Schnittstelle. Mehr ...
int	write (char out, bool blocking=true)
	Schreibe ein Byte auf die serieller Schnittstelle. Mehr ...
bool	receiveInterrupt (bool enable)
	Unterbrechung bei Datenempfang. Mehr ...

Private Typen
enum	regIndex
	Registerindex.

Private Methoden
char	readReg (Serial::regIndex reg)
	Lese Wert aus Register. Mehr ...
void	writeReg (Serial::regIndex reg, char out)
	Schreibe Wert in Register. Mehr ...

Private Attribute
const Serial::comPort	port
	gewähltes Register

Ausführliche Beschreibung

Serielle Schnittstelle.

Mit Hilfe dieser Klasse kann man über die serielle Schnittstelle (COM1 - COM4) einfach mit der Außenwelt kommunizieren.

Dokumentation der Aufzählungstypen

baudRate

enum Serial::baudRate

Übertragungsgeschwindigkeit.

Baud ist die Einheit für die Übertragungsrate von Symbolen, dabei entspricht 1 Baud der Geschwindigkeit für die Übertragung eines Symbols pro Sekunde. Die möglichen Baudraten sind ganzzählige Teiler der Taktrate von 115200 Hz.

comPort

enum Serial::comPort

COM-Port.

Die seriellen Schnittstelle (und ihre Hardwareadresse). Moderne Desktop-PCs besitzen derzeit meist maximal einen physikalischen Anschluss (COM1).

Beschreibung der Konstruktoren und Destruktoren

Serial()

Serial::Serial	(	Serial::comPort	port = COM1,
		Serial::baudRate	baudrate = BAUD_115200,
		Serial::dataBits	databits = DATA_8BIT,
		Serial::stopBits	stopbits = STOP_1BIT,
		Serial::parity	parity = PARITY_NONE
	)

Konstruktor.

Festlegen des Ports und setzen der Parameter für die serielle Verbindung Standardmäßig ist dies 8N1 (8 bit, kein Paritätsbit, ein Stopbit) mit 115200 Baud auf COM1.

Dokumentation der Elementfunktionen

read()

int Serial::read

(

bool

blocking = true

)

Lese ein Byte von serieller Schnittstelle.

Parameter

blocking

Blockiere - Warte bis ein Byte anliegt

Rückgabe

gelesener Wert (oder -1 bei nicht blockierend falls kein Datum verfügbar)

readReg()

char Serial::readReg ( Serial::regIndex  reg )

private

Lese Wert aus Register.

Parameter

reg	Registerindex

Rückgabe

gelesener Wert

receiveInterrupt()

bool Serial::receiveInterrupt

(

bool

enable

)

Unterbrechung bei Datenempfang.

Aktiviert oder deaktiviert den Interrupt bei Datenempfang. Dazu wird neben dem entsprechenden Register auch der IOAPIC (unter Berücksichtigung des jeweiligen COM-Ports) konfiguriert sowie der Empfangspuffer geleert.

Parameter

enable

Soll die Unterbrechung aktiviert werden?

Rückgabe

true falls die Unterbrechung zuvor aktiviert war, ansonst false

write()

int Serial::write	(	char	out,
		bool	blocking = true
	)

Schreibe ein Byte auf die serieller Schnittstelle.

Parameter

out	zu schreibendes Byte
blocking	Blockiere - Warte bis ein Byte geschrieben werden kann

Rückgabe

geschriebenes Byte (oder -1 falls kein Byte geschrieben werden konnte)

writeReg()

void Serial::writeReg ( Serial::regIndex  reg, char  out  )

private

Schreibe Wert in Register.

Parameter

reg	Registerindex
out	zu schreibender Wert

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien:

• machine/serial.h
• machine/serial.cc