Go - RS232 Bricklet

Dies ist die Beschreibung der Go API Bindings für das RS232 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des RS232 Bricklet 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
36
37
38
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/rs232_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.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rs232, _ := rs232_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 [60]rune, length uint8) {
        fmt.Println("Message (Length %d) %s", length, string(message[:length]))
    })

    // Enable read callback
    rs232.EnableReadCallback()

    var chars [60]rune
    testChars := []rune{'t', 'e', 's', 't'}
    copy(chars[:], testChars)

    rs232.Write(chars, 4)

    fmt.Print("Press enter to exit.")
    fmt.Scanln()
}

API

Die API des RS232 Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/rs232_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:

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

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

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

func rs232_bricklet.New(uid string, ipcon *IPConnection) (device RS232Bricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: RS232Bricklet
  • err – Typ: error

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

device, err := rs232_bricklet.New("YOUR_DEVICE_UID", &ipcon)

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

func (*RS232Bricklet) Write(message [60]rune, length uint8) (written uint8, err error)
Parameter:
  • message – Typ: [60]rune
  • length – Typ: uint8, Wertebereich: [0 bis 60]
Rückgabe:
  • written – Typ: uint8, Wertebereich: [0 bis 60]
  • err – Typ: error

Schreibt einen String aus bis zu 60 Zeichen auf die RS232-Schnittstelle. Der String kann aus Binärdaten bestehen, ASCII o.ä. ist nicht notwendig.

Die Länge des Strings muss als ein zusätzlicher Parameter angegeben werden.

Der Rückgabewert ist die Anzahl der Zeichen die geschrieben werden konnten.

Siehe SetConfiguration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

func (*RS232Bricklet) Read() (message [60]rune, length uint8, err error)
Rückgabe:
  • message – Typ: [60]rune
  • length – Typ: uint8, Wertebereich: [0 bis 60]
  • err – Typ: error

Gibt die aktuell gespeicherte Nachricht zurück. Die maximale Länge beträgt 60. Wenn die Länge als 0 gegeben wird, waren keine neuen Daten verfügbar.

Anstatt mit dieser Funktion zu pollen, ist es auch möglich Callbacks zu nutzen. Siehe EnableReadCallback() und RegisterReadCallback Callback.

func (*RS232Bricklet) SetConfiguration(baudrate uint8, parity uint8, stopbits uint8, wordlength uint8, hardwareFlowcontrol uint8, softwareFlowcontrol uint8) (err error)
Parameter:
  • baudrate – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 11
  • parity – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • stopbits – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • wordlength – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 8
  • hardwareFlowcontrol – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • softwareFlowcontrol – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration für die RS232-Kommunikation.

Hard-/Software Flow Control kann entweder an oder aus sein aber nicht beides gleichzeitig an.

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

Für baudrate:

  • rs232_bricklet.Baudrate300 = 0
  • rs232_bricklet.Baudrate600 = 1
  • rs232_bricklet.Baudrate1200 = 2
  • rs232_bricklet.Baudrate2400 = 3
  • rs232_bricklet.Baudrate4800 = 4
  • rs232_bricklet.Baudrate9600 = 5
  • rs232_bricklet.Baudrate14400 = 6
  • rs232_bricklet.Baudrate19200 = 7
  • rs232_bricklet.Baudrate28800 = 8
  • rs232_bricklet.Baudrate38400 = 9
  • rs232_bricklet.Baudrate57600 = 10
  • rs232_bricklet.Baudrate115200 = 11
  • rs232_bricklet.Baudrate230400 = 12

Für parity:

  • rs232_bricklet.ParityNone = 0
  • rs232_bricklet.ParityOdd = 1
  • rs232_bricklet.ParityEven = 2
  • rs232_bricklet.ParityForcedParity1 = 3
  • rs232_bricklet.ParityForcedParity0 = 4

Für stopbits:

  • rs232_bricklet.Stopbits1 = 1
  • rs232_bricklet.Stopbits2 = 2

Für wordlength:

  • rs232_bricklet.Wordlength5 = 5
  • rs232_bricklet.Wordlength6 = 6
  • rs232_bricklet.Wordlength7 = 7
  • rs232_bricklet.Wordlength8 = 8

Für hardwareFlowcontrol:

  • rs232_bricklet.HardwareFlowcontrolOff = 0
  • rs232_bricklet.HardwareFlowcontrolOn = 1

Für softwareFlowcontrol:

  • rs232_bricklet.SoftwareFlowcontrolOff = 0
  • rs232_bricklet.SoftwareFlowcontrolOn = 1
func (*RS232Bricklet) GetConfiguration() (baudrate uint8, parity uint8, stopbits uint8, wordlength uint8, hardwareFlowcontrol uint8, softwareFlowcontrol uint8, err error)
Rückgabe:
  • baudrate – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 11
  • parity – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • stopbits – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • wordlength – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 8
  • hardwareFlowcontrol – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • softwareFlowcontrol – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • err – Typ: error

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

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

Für baudrate:

  • rs232_bricklet.Baudrate300 = 0
  • rs232_bricklet.Baudrate600 = 1
  • rs232_bricklet.Baudrate1200 = 2
  • rs232_bricklet.Baudrate2400 = 3
  • rs232_bricklet.Baudrate4800 = 4
  • rs232_bricklet.Baudrate9600 = 5
  • rs232_bricklet.Baudrate14400 = 6
  • rs232_bricklet.Baudrate19200 = 7
  • rs232_bricklet.Baudrate28800 = 8
  • rs232_bricklet.Baudrate38400 = 9
  • rs232_bricklet.Baudrate57600 = 10
  • rs232_bricklet.Baudrate115200 = 11
  • rs232_bricklet.Baudrate230400 = 12

Für parity:

  • rs232_bricklet.ParityNone = 0
  • rs232_bricklet.ParityOdd = 1
  • rs232_bricklet.ParityEven = 2
  • rs232_bricklet.ParityForcedParity1 = 3
  • rs232_bricklet.ParityForcedParity0 = 4

Für stopbits:

  • rs232_bricklet.Stopbits1 = 1
  • rs232_bricklet.Stopbits2 = 2

Für wordlength:

  • rs232_bricklet.Wordlength5 = 5
  • rs232_bricklet.Wordlength6 = 6
  • rs232_bricklet.Wordlength7 = 7
  • rs232_bricklet.Wordlength8 = 8

Für hardwareFlowcontrol:

  • rs232_bricklet.HardwareFlowcontrolOff = 0
  • rs232_bricklet.HardwareFlowcontrolOn = 1

Für softwareFlowcontrol:

  • rs232_bricklet.SoftwareFlowcontrolOff = 0
  • rs232_bricklet.SoftwareFlowcontrolOn = 1
func (*RS232Bricklet) SetBreakCondition(breakTime uint16) (err error)
Parameter:
  • breakTime – Typ: uint16, Einheit: 1 ms, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • err – Typ: error

Setzt eine Break Condition (die TX-Ausgabe wird fest of logisch 0 gezwungen). Der Parameter setzt die Haltezeit der Break Condition.

Neu in Version 2.0.2 (Plugin).

Fortgeschrittene Funktionen

func (*RS232Bricklet) GetIdentity() (uid string, connectedUid string, position rune, hardwareVersion [3]uint8, firmwareVersion [3]uint8, deviceIdentifier uint16, err error)
Rückgabe:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: rune, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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.

Konfigurationsfunktionen für Callbacks

func (*RS232Bricklet) EnableReadCallback() (err error)
Rückgabe:
  • err – Typ: error

Aktiviert den RegisterReadCallback Callback.

Im Startzustand ist der Callback deaktiviert

func (*RS232Bricklet) DisableReadCallback() (err error)
Rückgabe:
  • err – Typ: error

Deaktiviert den RegisterReadCallback Callback.

Im Startzustand ist der Callback deaktiviert

func (*RS232Bricklet) IsReadCallbackEnabled() (enabled bool, err error)
Rückgabe:
  • enabled – Typ: bool, Standardwert: false
  • err – Typ: 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 (*RS232Bricklet) RegisterReadCallback(func(message [60]rune, length uint8)) (registrationId uint64)
Callback-Parameter:
  • message – Typ: [60]rune
  • length – Typ: uint8, Wertebereich: [1 bis 60]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird aufgerufen wenn neue Daten zur Verfügung stehen. Die Nachricht hat eine Maximalgröße von 60 Zeichen. Die Länge der Nachricht wird zusätzlich übergeben.

Dieser Callback kann durch EnableReadCallback() aktiviert werden.

func (*RS232Bricklet) RegisterErrorCallback(func(error uint8)) (registrationId uint64)
Callback-Parameter:
  • error – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird aufgerufen wenn ein Fehler auftritt. Mögliche Fehler sind Overrun-, Parity- oder Framing-Fehler.

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

Für error:

  • rs232_bricklet.ErrorOverrun = 1
  • rs232_bricklet.ErrorParity = 2
  • rs232_bricklet.ErrorFraming = 4

Neu in Version 2.0.1 (Plugin).

Virtuelle Funktionen

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.

func (*RS232Bricklet) GetAPIVersion() (apiVersion [3]uint8, err error)
Rückgabe:
  • apiVersion – Typ: [3]uint8
    • 0: major – Typ: uint8, Wertebereich: [0 bis 255]
    • 1: minor – Typ: uint8, Wertebereich: [0 bis 255]
    • 2: revision – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

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.

func (*RS232Bricklet) GetResponseExpected(functionId uint8) (responseExpected bool, err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool
  • err – Typ: 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.

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

Für functionId:

  • rs232_bricklet.FunctionEnableReadCallback = 3
  • rs232_bricklet.FunctionDisableReadCallback = 4
  • rs232_bricklet.FunctionSetConfiguration = 6
  • rs232_bricklet.FunctionSetBreakCondition = 10
func (*RS232Bricklet) SetResponseExpected(functionId uint8, responseExpected bool) (err error)
Parameter:
  • functionId – Typ: uint8, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: 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 Konstanten sind für diese Funktion verfügbar:

Für functionId:

  • rs232_bricklet.FunctionEnableReadCallback = 3
  • rs232_bricklet.FunctionDisableReadCallback = 4
  • rs232_bricklet.FunctionSetConfiguration = 6
  • rs232_bricklet.FunctionSetBreakCondition = 10
func (*RS232Bricklet) SetResponseExpectedAll(responseExpected bool) (err error)
Parameter:
  • responseExpected – Typ: bool
Rückgabe:
  • err – Typ: error

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

Konstanten

rs232_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein RS232 Bricklet 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_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines RS232 Bricklet dar.