Go - RS232 Bricklet 2.0

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.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Loopback

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 RX pin to the TX pin on the same Bricklet

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()
}

API

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 DeviceError, der das error-Interface implementiert, zurückgeben. Dieser kann folgende Werte annehmen:

  • DeviceErrorSuccess = 0
  • DeviceErrorInvalidParameter = 1
  • DeviceErrorFunctionNotSupported = 2
  • DeviceErrorUnknownError = 3

welche den Werten entsprechen, die der Brick oder das Bricklet zurückgeben.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func NewRS232V2Bricklet(uid string, ipcon *IPConnection) (device RS232V2Bricklet, err error)

Erzeugt ein neues RS232V2Bricklet-Objekt mit der eindeutigen Geräte ID uid und fügt es der IPConnection ipcon hinzu:

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden wurde (siehe Beispiele oben).

func (*RS232V2Bricklet) Write(message []rune) (messageChunkWritten uint64, err error)

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.

func (*RS232V2Bricklet) Read(length uint16) (message []rune, err error)

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 RegisterReadCallback Callback.

func (*RS232V2Bricklet) SetConfiguration(baudrate uint32, parity Parity, stopbits Stopbits, wordlength Wordlength, flowcontrol Flowcontrol) (err error)

Setzt die Konfiguration für die RS232-Kommunikation. Verfügbare Optionen sind:

  • Baudrate zwischen 100 und 2000000 Baud.
  • Parität von None, Odd und Even.
  • Stopp-Bits von 1 oder 2.
  • Wortlänge zwischen 5 und 8.
  • Flow Control kann aus, Software oder Hardware sein.

Der Standard ist: 115200 Baud, Parität None, 1 Stop Bits, Wortlänge 8.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • ParityNone = 0
  • ParityOdd = 1
  • ParityEven = 2
  • Stopbits1 = 1
  • Stopbits2 = 2
  • Wordlength5 = 5
  • Wordlength6 = 6
  • Wordlength7 = 7
  • Wordlength8 = 8
  • FlowcontrolOff = 0
  • FlowcontrolSoftware = 1
  • FlowcontrolHardware = 2
func (*RS232V2Bricklet) GetConfiguration() (baudrate uint32, parity Parity, stopbits Stopbits, wordlength Wordlength, flowcontrol Flowcontrol, err error)

Gibt die Konfiguration zurück, wie von SetConfiguration() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • ParityNone = 0
  • ParityOdd = 1
  • ParityEven = 2
  • Stopbits1 = 1
  • Stopbits2 = 2
  • Wordlength5 = 5
  • Wordlength6 = 6
  • Wordlength7 = 7
  • Wordlength8 = 8
  • FlowcontrolOff = 0
  • FlowcontrolSoftware = 1
  • FlowcontrolHardware = 2

Fortgeschrittene Funktionen

func (*RS232V2Bricklet) SetBufferConfig(sendBufferSize uint16, receiveBufferSize uint16) (err error)

Setzt die Größe des Sende- und Empfangsbuffers. In Summe müssen die Buffer eine Größe von 10240 Byte (10kb) haben, die Minimalgröße ist 1024 Byte (1kb) 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 RegisterReadCallback Callback an ein Nutzerprogramm übertragen werden konnten.

Die Standardkonfiguration ist 5120 Byte (5kb) pro Buffer.

func (*RS232V2Bricklet) GetBufferConfig() (sendBufferSize uint16, receiveBufferSize uint16, err error)

Gibt die Buffer-Konfiguration zurück, wie von SetBufferConfig() gesetzt.

func (*RS232V2Bricklet) GetBufferStatus() (sendBufferUsed uint16, receiveBufferUsed uint16, err error)

Gibt die aktuell genutzten Bytes des Sende- und Empfangsbuffers zurück.

Siehe SetBufferConfig() zur Konfiguration der Buffergrößen.

func (*RS232V2Bricklet) GetErrorCount() (errorCountOverrun uint32, errorCountParity uint32, err error)

Gibt die aktuelle Anzahl an Overrun und Parity Fehlern zurück.

func (*RS232V2Bricklet) GetAPIVersion() (apiVersion [3]uint8, err error)

Gibt die Version der API Definition (Major, Minor, Revision) 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.

func (*RS232V2Bricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)

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.

Siehe SetResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

func (*RS232V2Bricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • FunctionEnableReadCallback = 3
  • FunctionDisableReadCallback = 4
  • FunctionSetConfiguration = 6
  • FunctionSetBufferConfig = 8
  • FunctionSetWriteFirmwarePointer = 237
  • FunctionSetStatusLEDConfig = 239
  • FunctionReset = 243
  • FunctionWriteUID = 248
func (*RS232V2Bricklet) SetResponseExpectedAll(responseExpected bool) (err error)

Ändert das Response-Expected-Flag für alle Setter-Funktionen und Konfigurationsfunktionen für Callbacks diese Gerätes.

func (*RS232V2Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

  • ACK-Checksummen Fehler,
  • Message-Checksummen Fehler,
  • Framing Fehler und
  • Overflow Fehler.

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.

func (*RS232V2Bricklet) SetBootloaderMode(mode BootloaderMode) (status BootloaderStatus, err error)

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 Bootlodaer- 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:

  • BootloaderModeBootloader = 0
  • BootloaderModeFirmware = 1
  • BootloaderModeBootloaderWaitForReboot = 2
  • BootloaderModeFirmwareWaitForReboot = 3
  • BootloaderModeFirmwareWaitForEraseAndReboot = 4
  • BootloaderStatusOK = 0
  • BootloaderStatusInvalidMode = 1
  • BootloaderStatusNoChange = 2
  • BootloaderStatusEntryFunctionNotPresent = 3
  • BootloaderStatusDeviceIdentifierIncorrect = 4
  • BootloaderStatusCRCMismatch = 5
func (*RS232V2Bricklet) GetBootloaderMode() (mode BootloaderMode, err error)

Gibt den aktuellen Bootloader-Modus zurück, siehe SetBootloaderMode().

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • BootloaderModeBootloader = 0
  • BootloaderModeFirmware = 1
  • BootloaderModeBootloaderWaitForReboot = 2
  • BootloaderModeFirmwareWaitForReboot = 3
  • BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*RS232V2Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)

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.

func (*RS232V2Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)

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.

func (*RS232V2Bricklet) SetStatusLEDConfig(config StatusLEDConfig) (err error)

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:

  • StatusLEDConfigOff = 0
  • StatusLEDConfigOn = 1
  • StatusLEDConfigShowHeartbeat = 2
  • StatusLEDConfigShowStatus = 3
func (*RS232V2Bricklet) GetStatusLEDConfig() (config StatusLEDConfig, err error)

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig() gesetzt.

Die folgenden Konstanten sind für diese Funktion verfügbar:

  • StatusLEDConfigOff = 0
  • StatusLEDConfigOn = 1
  • StatusLEDConfigShowHeartbeat = 2
  • StatusLEDConfigShowStatus = 3
func (*RS232V2Bricklet) GetChipTemperature() (temperature int16, err error)

Gibt die Temperatur in °C, 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.

func (*RS232V2Bricklet) Reset() (err error)

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.

func (*RS232V2Bricklet) WriteUID(uid uint32) (err error)

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.

func (*RS232V2Bricklet) ReadUID() (uid uint32, err error)

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

func (*RS232V2Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks

func (*RS232V2Bricklet) EnableReadCallback() (err error)

Aktiviert den RegisterReadCallback Callback.

Im Startzustand ist der Callback deaktiviert.

func (*RS232V2Bricklet) DisableReadCallback() (err error)

Deaktiviert den RegisterReadCallback Callback.

Im Startzustand ist der Callback deaktiviert.

func (*RS232V2Bricklet) IsReadCallbackEnabled() (enabled bool, err error)

Gibt true zurück falls RegisterReadCallback Callback aktiviert ist, false sonst.

Callbacks

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.

func (*RS232V2Bricklet) RegisterReadCallback(func(message []rune)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterReadCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterReadCallback(registrationId uint64) wieder entfernt werden.

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen.

Dieser Callback kann durch EnableReadCallback() aktiviert werden.

func (*RS232V2Bricklet) RegisterErrorCountCallback(func(errorCountOverrun uint32, errorCountParity uint32)) (registrationId uint64)

Ein Callback für dieses Event kann mit der Funktion RegisterErrorCountCallback() hinzugefügt werden. Diese gibt die ID des registrierten Callbacks zurück. Ein hinzugefügtes Callback kann mit der Funktion DeregisterErrorCountCallback(registrationId uint64) wieder entfernt werden.

Dieser Callback wird aufgerufen wenn ein neuer Fehler auftritt. Er gibt die Anzahl der aufgetreten Overrun und Parity Fehler zurück.

Konstanten

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.