Dies ist die Beschreibung der Go API Bindings für das RS232 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS232 Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.
Eine Installationanleitung für die Go API Bindings ist Teil deren allgemeine Beschreibung. Zusätzliche Dokumentation findet sich auf godoc.org.
Der folgende Beispielcode ist Public Domain (CC0 1.0).
Download (example_loopback.go)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 | package main
import (
"fmt"
"github.com/Tinkerforge/go-api-bindings/ipconnection"
"github.com/Tinkerforge/go-api-bindings/rs232_v2_bricklet"
)
// For this example connect the RX1 and TX pin to receive the send message
const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your RS232 Bricklet 2.0.
func main() {
ipcon := ipconnection.New()
defer ipcon.Close()
rs232, _ := rs232_v2_bricklet.New(UID, &ipcon) // Create device object.
ipcon.Connect(ADDR) // Connect to brickd.
defer ipcon.Disconnect()
// Don't use device before ipcon is connected.
rs232.RegisterReadCallback(func(message []rune) {
fmt.Println(string(message))
})
// Enable read callback
rs232.EnableReadCallback()
// Write "test" string
rs232.Write([]rune{'t', 'e', 's', 't'})
fmt.Print("Press enter to exit.")
fmt.Scanln()
}
|
Die API des RS232 Bricklet 2.0 ist im Package github.com/Tinkerforge/go-api-bindings/rs232_v2_bricklet
definiert.
Fast alle Funktionen der Go Bindings können einen ipconnection.DeviceError
, der das error-Interface implementiert,
zurückgeben. Dieser kann folgende Werte annehmen:
welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.
Alle folgend aufgelisteten Funktionen sind Thread-sicher.
rs232_v2_bricklet.
New
(uid string, ipcon *IPConnection) (device RS232V2Bricklet, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Erzeugt ein neues RS232V2Bricklet
-Objekt mit der eindeutigen Geräte ID uid
und
fügt es der IPConnection ipcon
hinzu:
device, err := rs232_v2_bricklet.New("YOUR_DEVICE_UID", &ipcon)
Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.
(*RS232V2Bricklet)
Write
(message []rune) (messageChunkWritten uint64, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt Zeichen auf die RS232-Schnittstelle. Die Zeichen können Binärdaten sein, ASCII o.ä. ist nicht notwendig.
Der Rückgabewert ist die Anzahl der Zeichen die geschrieben wurden.
Siehe SetConfiguration()
für Konfigurationsmöglichkeiten
bezüglich Baudrate, Parität usw.
(*RS232V2Bricklet)
Read
(length uint16) (message []rune, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt bis zu length Zeichen aus dem Empfangsbuffer zurück.
Anstatt mit dieser Funktion zu pollen, ist es auch möglich
Callbacks zu nutzen. Diese Funktion gibt nur Daten zurück wenn
der Read-Callback nicht aktiv ist.
Siehe EnableReadCallback()
und ReadCallback
Callback.
(*RS232V2Bricklet)
SetConfiguration
(baudrate uint32, parity uint8, stopbits uint8, wordlength uint8, flowcontrol uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Konfiguration für die RS232-Kommunikation.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für parity:
Für stopbits:
Für wordlength:
Für flowcontrol:
(*RS232V2Bricklet)
GetConfiguration
() (baudrate uint32, parity uint8, stopbits uint8, wordlength uint8, flowcontrol uint8, err error)¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetConfiguration()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für parity:
Für stopbits:
Für wordlength:
Für flowcontrol:
(*RS232V2Bricklet)
SetBufferConfig
(sendBufferSize uint16, receiveBufferSize uint16) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Größe des Sende- und Empfangsbuffers. In Summe müssen die Buffer eine Größe von 10240 Byte (10KiB) haben, die Minimalgröße ist 1024 Byte (1KiB) für beide.
Der aktuelle Bufferinhalt geht bei einem Aufruf dieser Funktion verloren.
Der Sendebuffer hält die Daten welche über Write()
übergeben und noch
nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche
über RS232 empfangen wurden aber noch nicht über Read()
oder
ReadCallback
Callback an ein Nutzerprogramm übertragen werden konnten.
(*RS232V2Bricklet)
GetBufferConfig
() (sendBufferSize uint16, receiveBufferSize uint16, err error)¶Rückgabe: |
|
---|
Gibt die Buffer-Konfiguration zurück, wie von SetBufferConfig()
gesetzt.
(*RS232V2Bricklet)
GetBufferStatus
() (sendBufferUsed uint16, receiveBufferUsed uint16, err error)¶Rückgabe: |
|
---|
Gibt die aktuell genutzten Bytes des Sende- und Empfangsbuffers zurück.
Siehe SetBufferConfig()
zur Konfiguration der Buffergrößen.
(*RS232V2Bricklet)
GetErrorCount
() (errorCountOverrun uint32, errorCountParity uint32, err error)¶Rückgabe: |
|
---|
Gibt die aktuelle Anzahl an Overrun und Parity Fehlern zurück.
(*RS232V2Bricklet)
GetSPITFPErrorCount
() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)¶Rückgabe: |
|
---|
Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.
Die Fehler sind aufgeteilt in
Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.
(*RS232V2Bricklet)
SetStatusLEDConfig
(config uint8) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.
Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.
Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
(*RS232V2Bricklet)
GetStatusLEDConfig
() (config uint8, err error)¶Rückgabe: |
|
---|
Gibt die Konfiguration zurück, wie von SetStatusLEDConfig()
gesetzt.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für config:
(*RS232V2Bricklet)
GetChipTemperature
() (temperature int16, err error)¶Rückgabe: |
|
---|
Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.
Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.
(*RS232V2Bricklet)
Reset
() (err error)¶Rückgabe: |
|
---|
Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.
Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.
(*RS232V2Bricklet)
GetIdentity
() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)¶Rückgabe: |
|
---|
Gibt die UID, die UID zu der das Bricklet verbunden ist, die Position, die Hard- und Firmware Version sowie den Device Identifier zurück.
Die Position ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.
Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.
(*RS232V2Bricklet)
EnableReadCallback
() (err error)¶Rückgabe: |
|
---|
Aktiviert den ReadCallback
Callback. Dies deaktiviert den FrameReadableCallback
Callback.
Im Startzustand ist der Callback deaktiviert.
(*RS232V2Bricklet)
DisableReadCallback
() (err error)¶Rückgabe: |
|
---|
Deaktiviert den ReadCallback
Callback.
Im Startzustand ist der Callback deaktiviert.
(*RS232V2Bricklet)
IsReadCallbackEnabled
() (enabled bool, err error)¶Rückgabe: |
|
---|
Gibt true zurück falls ReadCallback
Callback aktiviert ist,
false sonst.
(*RS232V2Bricklet)
SetFrameReadableCallbackConfiguration
(frameSize uint16) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Konfiguriert den FrameReadableCallback
Callback. Die Frame Size ist die Anzahl an Bytes, die lesbar sein müssen, damit der Callback auslöst.
Eine Frame Size von 0 deaktiviert den Callback. Eine Frame Size größer als 0 aktiviert diesen und deaktiviert den ReadCallback
Callback.
Im Startzustand ist der Callback deaktiviert.
Neu in Version 2.0.3 (Plugin).
(*RS232V2Bricklet)
GetFrameReadableCallbackConfiguration
() (frameSize uint16, err error)¶Rückgabe: |
|
---|
Gibt die Callback-Konfiguration zurück, wie mittels SetFrameReadableCallbackConfiguration()
gesetzt.
Neu in Version 2.0.3 (Plugin).
Callbacks können registriert werden um zeitkritische
oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann
mit der entsprechenden Register*Callback
-Function durchgeführt werden,
welche eine eindeutige Callback-ID zurück gibt. Mit dieser ID kann das Callback
später deregistriert werden.
Bemerkung
Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.
(*RS232V2Bricklet)
RegisterReadCallback
(func(message []rune)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen.
Dieser Callback kann durch EnableReadCallback()
aktiviert werden.
Bemerkung
Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit nil für message ausgelöst.
(*RS232V2Bricklet)
RegisterErrorCountCallback
(func(errorCountOverrun uint32, errorCountParity uint32)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Parity Fehler zurück.
(*RS232V2Bricklet)
RegisterFrameReadableCallback
(func(frameCount uint16)) (registrationId uint64)¶Callback-Parameter: |
|
---|---|
Rückgabe: |
|
Dieser Callback wird ausgelöst, wenn mindestens ein neuer Frame an Daten verfügbar sind. Die Größe eines Frames kann mit SetFrameReadableCallbackConfiguration()
konfiguriert werden.
Frame Count ist die Anzahl an Frames, die zum Lesen bereitstehen.
Der Callback wird nur einmal pro Read()
Aufruf ausgelöst. Das heißt, dass wenn eine Framegröße von X Bytes konfiguriert wird, jedes Mal
wenn das Callback ausgelöst wird, X Bytes mit der Read()
-Funktion gelesen werden können, ohne dass der Frame Count-Parameter des Callbacks geprüft werden muss.
Neu in Version 2.0.3 (Plugin).
Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.
(*RS232V2Bricklet)
GetAPIVersion
() (apiVersion [3]uint8, err error)¶Rückgabe: |
|
---|
Gibt die Version der API Definition zurück, die diese API Bindings implementieren. Dies ist weder die Release-Version dieser API Bindings noch gibt es in irgendeiner Weise Auskunft über den oder das repräsentierte(n) Brick oder Bricklet.
(*RS232V2Bricklet)
GetResponseExpected
(functionId uint8) (responseExpected bool, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Gibt das Response-Expected-Flag für die Funktion mit der angegebenen Funktions IDs zurück. Es ist true falls für die Funktion beim Aufruf eine Antwort erwartet wird, false andernfalls.
Für Getter-Funktionen ist diese Flag immer gesetzt und kann nicht entfernt
werden, da diese Funktionen immer eine Antwort senden. Für
Konfigurationsfunktionen für Callbacks ist es standardmäßig gesetzt, kann aber
entfernt werden mittels SetResponseExpected()
. Für Setter-Funktionen ist
es standardmäßig nicht gesetzt, kann aber gesetzt werden.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für functionId:
(*RS232V2Bricklet)
SetResponseExpected
(functionId uint8, responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für die Funktion mit der angegebenen Funktion IDs. Diese Flag kann nur für Setter-Funktionen (Standardwert: false) und Konfigurationsfunktionen für Callbacks (Standardwert: true) geändert werden. Für Getter-Funktionen ist das Flag immer gesetzt.
Wenn das Response-Expected-Flag für eine Setter-Funktion gesetzt ist, können Timeouts und andere Fehlerfälle auch für Aufrufe dieser Setter-Funktion detektiert werden. Das Gerät sendet dann eine Antwort extra für diesen Zweck. Wenn das Flag für eine Setter-Funktion nicht gesetzt ist, dann wird keine Antwort vom Gerät gesendet und Fehler werden stillschweigend ignoriert, da sie nicht detektiert werden können.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für functionId:
(*RS232V2Bricklet)
SetResponseExpectedAll
(responseExpected bool) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.
Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.
(*RS232V2Bricklet)
SetBootloaderMode
(mode uint8) (status uint8, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.
Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
Für status:
(*RS232V2Bricklet)
GetBootloaderMode
() (mode uint8, err error)¶Rückgabe: |
|
---|
Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode()
.
Die folgenden Konstanten sind für diese Funktion verfügbar:
Für mode:
(*RS232V2Bricklet)
SetWriteFirmwarePointer
(pointer uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Setzt den Firmware-Pointer für WriteFirmware()
. Der Pointer
muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke
in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
(*RS232V2Bricklet)
WriteFirmware
(data [64]uint8) (status uint8, err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt 64 Bytes Firmware an die Position die vorher von
SetWriteFirmwarePointer()
gesetzt wurde. Die Firmware wird
alle 4 Datenblöcke in den Flash geschrieben.
Eine Firmware kann nur im Bootloader-Mode geschrieben werden.
Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.
(*RS232V2Bricklet)
WriteUID
(uid uint32) (err error)¶Parameter: |
|
---|---|
Rückgabe: |
|
Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.
Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.
(*RS232V2Bricklet)
ReadUID
() (uid uint32, err error)¶Rückgabe: |
|
---|
Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.
rs232_v2_bricklet.
DeviceIdentifier
¶Diese Konstante wird verwendet um ein RS232 Bricklet 2.0 zu identifizieren.
Die GetIdentity()
Funktion und
der (*IPConnection) RegisterEnumerateCallback
Callback der IPConnection haben ein deviceIdentifier
Parameter um den Typ
des Bricks oder Bricklets anzugeben.
rs232_v2_bricklet.
DeviceDisplayName
¶Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet 2.0 dar.