Go - RS485 Bricklet

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

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/rs485_bricklet"
)

// For this example connect the RX+/- pins to TX+/- pins on the same Bricklet
// and configure the DIP switch on the Bricklet to full-duplex mode

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your RS485 Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rs485, _ := rs485_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Enable full-duplex mode
    rs485.SetRS485Configuration(115200, rs485_bricklet.ParityNone,
        rs485_bricklet.Stopbits1,
        rs485_bricklet.Wordlength8,
        rs485_bricklet.DuplexFull)

    rs485.RegisterReadCallback(func(message []rune) {
        fmt.Println(string(message))
    })

    // Enable read callback
    rs485.EnableReadCallback()

    rs485.Write([]rune{'t', 'e', 's', 't'})

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

Modbus Slave

Download (example_modbus_slave.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
39
40
41
42
43
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/rs485_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your RS485 Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rs485, _ := rs485_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Set operating mode to Modbus RTU slave
    rs485.SetMode(rs485_bricklet.ModeModbusSlaveRTU)

    // Modbus specific configuration:
    // - slave address = 17
    // - master request timeout = 0ms (unused in slave mode)
    rs485.SetModbusConfiguration(17, 0)

    rs485.RegisterModbusSlaveWriteSingleRegisterRequestCallback(func(requestID uint8, registerAddress uint32, registerValue uint16) {
        fmt.Println("Request ID: ", requestID)
        fmt.Println("Register Address: ", registerAddress)
        fmt.Println("Register Value: ", registerValue)
        if registerAddress != 42 {
            fmt.Println("Error: Invalid register address")
            rs485.ModbusSlaveReportException(requestID, rs485_bricklet.ExceptionCodeIllegalDataAddress)
        } else {
            rs485.ModbusSlaveAnswerWriteSingleRegisterRequest(requestID)
        }
    })

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

Modbus Master

Download (example_modbus_master.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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
package main

import (
    "fmt"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
    "github.com/Tinkerforge/go-api-bindings/rs485_bricklet"
)

const ADDR string = "localhost:4223"
const UID string = "XYZ" // Change XYZ to the UID of your RS485 Bricklet.

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    rs485, _ := rs485_bricklet.New(UID, &ipcon) // Create device object.

    ipcon.Connect(ADDR) // Connect to brickd.
    defer ipcon.Disconnect()
    // Don't use device before ipcon is connected.

    // Set operating mode to Modbus RTU master
    rs485.SetMode(rs485_bricklet.ModeModbusMasterRTU)

    // Modbus specific configuration:
    // - slave address = 1 (unused in master mode)
    // - master request timeout = 1000ms
    rs485.SetModbusConfiguration(1, 1000)

    expectedRequestID := uint8(0)

    rs485.RegisterModbusMasterWriteSingleRegisterResponseCallback(func(requestID uint8, exceptionCode rs485_bricklet.ExceptionCode) {
        fmt.Printf("Request ID: %d", requestID)
        if exceptionCode == rs485_bricklet.ExceptionCodeTimeout {
            fmt.Println("Exception Code: Timeout")
        } else if exceptionCode == rs485_bricklet.ExceptionCodeSuccess {
            fmt.Println("Exception Code: Success")
        } else if exceptionCode == rs485_bricklet.ExceptionCodeIllegalFunction {
            fmt.Println("Exception Code: Illegal Function")
        } else if exceptionCode == rs485_bricklet.ExceptionCodeIllegalDataAddress {
            fmt.Println("Exception Code: Illegal Data Address")
        } else if exceptionCode == rs485_bricklet.ExceptionCodeIllegalDataValue {
            fmt.Println("Exception Code: Illegal Data Value")
        } else if exceptionCode == rs485_bricklet.ExceptionCodeSlaveDeviceFailure {
            fmt.Println("Exception Code: Slave Device Failure")
        } else if exceptionCode == rs485_bricklet.ExceptionCodeAcknowledge {
            fmt.Println("Exception Code: Acknowledge")
        } else if exceptionCode == rs485_bricklet.ExceptionCodeSlaveDeviceBusy {
            fmt.Println("Exception Code: Slave Device Busy")
        } else if exceptionCode == rs485_bricklet.ExceptionCodeMemoryParityError {
            fmt.Println("Exception Code: Memory Parity Error")
        } else if exceptionCode == rs485_bricklet.ExceptionCodeGatewayPathUnavailable {
            fmt.Println("Exception Code: Gateway Path Unavailable")
        } else if exceptionCode == rs485_bricklet.ExceptionCodeGatewayTargetDeviceFailedToRespond {
            fmt.Println("Exception Code: Gateway Target Device Failed To Respond")
        }
        if requestID != expectedRequestID {
            fmt.Println("Error: Unexpected request ID")
        }
    })

    // Write 65535 to register 42 of slave 17
    expectedRequestID, _ = rs485.ModbusMasterWriteSingleRegister(17, 42, 65535)

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

API

Die API des RS485 Bricklet ist im Package github.com/Tinkerforge/go-api-bindings/rs485_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 rs485_bricklet.New(uid string, ipcon *IPConnection) (device RS485Bricklet, err error)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: *IPConnection
Rückgabe:
  • device – Typ: RS485Bricklet
  • err – Typ: error

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

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

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

func (*RS485Bricklet) Write(message []rune) (messageChunkWritten uint64, err error)
Parameter:
  • message – Typ: []rune, Länge: variabel
Rückgabe:
  • messageWritten – Typ: uint16, Wertebereich: [0 bis 216 - 1]
  • err – Typ: error

Schreibt Zeichen auf die RS485-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 SetRS485Configuration() für Konfigurationsmöglichkeiten bezüglich Baudrate, Parität usw.

func (*RS485Bricklet) Read(length uint16) (message []rune, err error)
Parameter:
  • length – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • message – Typ: []rune, Länge: variabel
  • err – Typ: 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 nich aktiv ist. Siehe EnableReadCallback() und RegisterReadCallback Callback.

func (*RS485Bricklet) SetRS485Configuration(baudrate uint32, parity uint8, stopbits uint8, wordlength uint8, duplex uint8) (err error)
Parameter:
  • baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200
  • parity – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • stopbits – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • wordlength – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 8
  • duplex – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration für die RS485-Kommunikation.

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

Für parity:

  • rs485_bricklet.ParityNone = 0
  • rs485_bricklet.ParityOdd = 1
  • rs485_bricklet.ParityEven = 2

Für stopbits:

  • rs485_bricklet.Stopbits1 = 1
  • rs485_bricklet.Stopbits2 = 2

Für wordlength:

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

Für duplex:

  • rs485_bricklet.DuplexHalf = 0
  • rs485_bricklet.DuplexFull = 1
func (*RS485Bricklet) GetRS485Configuration() (baudrate uint32, parity uint8, stopbits uint8, wordlength uint8, duplex uint8, err error)
Rückgabe:
  • baudrate – Typ: uint32, Einheit: 1 Bd, Wertebereich: [100 bis 2000000], Standardwert: 115200
  • parity – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • stopbits – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 1
  • wordlength – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 8
  • duplex – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • err – Typ: error

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

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

Für parity:

  • rs485_bricklet.ParityNone = 0
  • rs485_bricklet.ParityOdd = 1
  • rs485_bricklet.ParityEven = 2

Für stopbits:

  • rs485_bricklet.Stopbits1 = 1
  • rs485_bricklet.Stopbits2 = 2

Für wordlength:

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

Für duplex:

  • rs485_bricklet.DuplexHalf = 0
  • rs485_bricklet.DuplexFull = 1
func (*RS485Bricklet) SetModbusConfiguration(slaveAddress uint8, masterRequestTimeout uint32) (err error)
Parameter:
  • slaveAddress – Typ: uint8, Wertebereich: [1 bis 247], Standardwert: 1
  • masterRequestTimeout – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 1000
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration für die RS485 Modbus Kommunikation. Verfügbare Optionen:

  • Slave Address: Addresse die vom Modbus-Slave im Modbus-Slave Modus genutzt wird. Der gültige Adressbereich ist 1 bis 247.
  • Master Request Timeout: Spezifiziert wie lange der Modbus-Master auf eine Antwort von einem Modbus-Slave wartet.
func (*RS485Bricklet) GetModbusConfiguration() (slaveAddress uint8, masterRequestTimeout uint32, err error)
Rückgabe:
  • slaveAddress – Typ: uint8, Wertebereich: [1 bis 247], Standardwert: 1
  • masterRequestTimeout – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 1000
  • err – Typ: error

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

func (*RS485Bricklet) SetMode(mode uint8) (err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
Rückgabe:
  • err – Typ: error

Setzt den Modus des Bricklets. Verfügbare Optionen sind

  • RS485,
  • Modbus-Master-RTU und
  • Modbus-Slave-RTU.

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

Für mode:

  • rs485_bricklet.ModeRS485 = 0
  • rs485_bricklet.ModeModbusMasterRTU = 1
  • rs485_bricklet.ModeModbusSlaveRTU = 2
func (*RS485Bricklet) GetMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • err – Typ: error

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

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

Für mode:

  • rs485_bricklet.ModeRS485 = 0
  • rs485_bricklet.ModeModbusMasterRTU = 1
  • rs485_bricklet.ModeModbusSlaveRTU = 2

Fortgeschrittene Funktionen

func (*RS485Bricklet) SetCommunicationLEDConfig(config uint8) (err error)
Parameter:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration der Kommunikations-LED. Standardmäßig zeigt die LED die RS485 Kommunikation durch Aufblinken an.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

  • rs485_bricklet.CommunicationLEDConfigOff = 0
  • rs485_bricklet.CommunicationLEDConfigOn = 1
  • rs485_bricklet.CommunicationLEDConfigShowHeartbeat = 2
  • rs485_bricklet.CommunicationLEDConfigShowCommunication = 3
func (*RS485Bricklet) GetCommunicationLEDConfig() (config uint8, err error)
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

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

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

Für config:

  • rs485_bricklet.CommunicationLEDConfigOff = 0
  • rs485_bricklet.CommunicationLEDConfigOn = 1
  • rs485_bricklet.CommunicationLEDConfigShowHeartbeat = 2
  • rs485_bricklet.CommunicationLEDConfigShowCommunication = 3
func (*RS485Bricklet) SetErrorLEDConfig(config uint8) (err error)
Parameter:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

Setzt die Konfiguration der Error-LED.

Standardmäßig geht die LED an, wenn ein Error auftritt (siehe RegisterErrorCountCallback Callback). Wenn diese Funktion danach nochmal mit der "SHOW ERROR"-Option aufgerufen wird, geht die LED wieder aus bis der nächste Error auftritt.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootloadermodus befindet ist die LED aus.

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

Für config:

  • rs485_bricklet.ErrorLEDConfigOff = 0
  • rs485_bricklet.ErrorLEDConfigOn = 1
  • rs485_bricklet.ErrorLEDConfigShowHeartbeat = 2
  • rs485_bricklet.ErrorLEDConfigShowError = 3
func (*RS485Bricklet) GetErrorLEDConfig() (config uint8, err error)
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

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

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

Für config:

  • rs485_bricklet.ErrorLEDConfigOff = 0
  • rs485_bricklet.ErrorLEDConfigOn = 1
  • rs485_bricklet.ErrorLEDConfigShowHeartbeat = 2
  • rs485_bricklet.ErrorLEDConfigShowError = 3
func (*RS485Bricklet) SetBufferConfig(sendBufferSize uint16, receiveBufferSize uint16) (err error)
Parameter:
  • sendBufferSize – Typ: uint16, Einheit: 1 B, Wertebereich: [1024 bis 9216], Standardwert: 5120
  • receiveBufferSize – Typ: uint16, Einheit: 1 B, Wertebereich: [1024 bis 9216], Standardwert: 5120
Rückgabe:
  • err – Typ: error

Setzt die Größe des Senden- und Empfangsbuffers. In Summe können 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 Sendenbuffer hält die Daten welche über Write() übergeben und noch nicht geschrieben werden konnten. Der Empfangsbuffer hält Daten welche über RS485 empfangen wurden aber noch nicht über Read() oder RegisterReadCallback Callback an ein Nutzerprogramm übertragen werden konnten.

func (*RS485Bricklet) GetBufferConfig() (sendBufferSize uint16, receiveBufferSize uint16, err error)
Rückgabe:
  • sendBufferSize – Typ: uint16, Einheit: 1 B, Wertebereich: [1024 bis 9216], Standardwert: 5120
  • receiveBufferSize – Typ: uint16, Einheit: 1 B, Wertebereich: [1024 bis 9216], Standardwert: 5120
  • err – Typ: error

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

func (*RS485Bricklet) GetBufferStatus() (sendBufferUsed uint16, receiveBufferUsed uint16, err error)
Rückgabe:
  • sendBufferUsed – Typ: uint16, Einheit: 1 B, Wertebereich: [1024 bis 9216]
  • receiveBufferUsed – Typ: uint16, Einheit: 1 B, Wertebereich: [1024 bis 9216]
  • err – Typ: error

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

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

func (*RS485Bricklet) GetErrorCount() (overrunErrorCount uint32, parityErrorCount uint32, err error)
Rückgabe:
  • overrunErrorCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • parityErrorCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

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

func (*RS485Bricklet) GetModbusCommonErrorCount() (timeoutErrorCount uint32, checksumErrorCount uint32, frameTooBigErrorCount uint32, illegalFunctionErrorCount uint32, illegalDataAddressErrorCount uint32, illegalDataValueErrorCount uint32, slaveDeviceFailureErrorCount uint32, err error)
Rückgabe:
  • timeoutErrorCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • checksumErrorCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • frameTooBigErrorCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • illegalFunctionErrorCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • illegalDataAddressErrorCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • illegalDataValueErrorCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • slaveDeviceFailureErrorCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

Gibt die aktuelle Fehleranzahl für verschiedene Fehlerarten Modbus-Modus zurück.

  • Timeout Error Count: Anzahl Timeouts.
  • Checksum Error Count: Anzahl von Modbus CRC16 Checksummen-Fehlern.
  • Frame Too Big Error Count: Anzahl von verworfenen Frames auf Grund einer zu großen Frame Größe (maximal 256 Byte).
  • Illegal Function Error Count: Anzahl der Anfragen von nicht-implementierten oder illegalen Funktionen. Entsprocht Modbus Exception Code 1.
  • Illegal Data Address Error Count: Anzahl der Anfragen mit ungütiger Adresse. Entspricht Modbus Exception Code 2.
  • Illegal Data Value Error Count: Anzahl der Anfragen mit ungültigem Datenwert. Entspricht Modbus Exception Code 3.
  • Slave Device Failure Error Count: Anzahl der nicht-behebaren Fehler eines Slaves. Entspricht Modbus Exception Code 4.
func (*RS485Bricklet) ModbusSlaveReportException(requestID uint8, exceptionCode int8) (err error)
Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: int8, Wertebereich: Siehe Konstanten
Rückgabe:
  • err – Typ: error

Im Modbus-Slave Modus kann diese Funktion genutzt werden um eine Modbus Exception auf eine Modbus-Master Anfrage zurückzugeben.

  • Request ID: Request ID einer Anfrage eines Slaves.
  • Exception Code: Modbus Exception Code für den Modbus Master.

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

Für exceptionCode:

  • rs485_bricklet.ExceptionCodeTimeout = -1
  • rs485_bricklet.ExceptionCodeSuccess = 0
  • rs485_bricklet.ExceptionCodeIllegalFunction = 1
  • rs485_bricklet.ExceptionCodeIllegalDataAddress = 2
  • rs485_bricklet.ExceptionCodeIllegalDataValue = 3
  • rs485_bricklet.ExceptionCodeSlaveDeviceFailure = 4
  • rs485_bricklet.ExceptionCodeAcknowledge = 5
  • rs485_bricklet.ExceptionCodeSlaveDeviceBusy = 6
  • rs485_bricklet.ExceptionCodeMemoryParityError = 8
  • rs485_bricklet.ExceptionCodeGatewayPathUnavailable = 10
  • rs485_bricklet.ExceptionCodeGatewayTargetDeviceFailedToRespond = 11
func (*RS485Bricklet) ModbusSlaveAnswerReadCoilsRequest(requestID uint8, coils []bool) (err error)
Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • coils – Typ: []bool, Länge: variabel
Rückgabe:
  • err – Typ: error

Im Modbus-Slave Modus kann diese Funktion genutzt werden un eine Read Coils-Anfrage eines Modbus-Masters zu beantworten.

  • Request ID: Request ID der zu beantwortenden Anfrage.
  • Coils: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom RegisterModbusSlaveReadCoilsRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

func (*RS485Bricklet) ModbusMasterReadCoils(slaveAddress uint8, startingAddress uint32, count uint16) (requestID uint8, err error)
Parameter:
  • slaveAddress – Typ: uint8, Wertebereich: [0 bis 247]
  • startingAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • count – Typ: uint16, Wertebereich: [1 bis 2000]
Rückgabe:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Im Modbus-Master Modus kann diese Funktion genutzt werden um Coils vom Slave zu lesen.

  • Slave Addresss: Adresse des Modbus-Slave
  • Starting Address: Nummer der ersten zu lesenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.
  • Count: Anzahl der zu lesenden Coils.

Nach erfolgreichen Ausführen der Leseoperation gibt diese Funktion eine Request ID zurück die nicht 0 ist. Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

Falls kein Fehler auftritt, wird auch der RegisterModbusMasterReadCoilsResponseCallback Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwortet auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

func (*RS485Bricklet) ModbusSlaveAnswerReadHoldingRegistersRequest(requestID uint8, holdingRegisters []uint16) (err error)
Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • holdingRegisters – Typ: []uint16, Länge: variabel, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • err – Typ: error

Im Modbus-Slave Modus kann diese Funktion genutzt werden un eine Read Holding Registers-Anfrage eines Modbus-Masters zu beantworten.

  • Request ID: Request ID der zu beantwortenden Anfrage.
  • Holding Registers: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom RegisterModbusSlaveReadHoldingRegistersRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

func (*RS485Bricklet) ModbusMasterReadHoldingRegisters(slaveAddress uint8, startingAddress uint32, count uint16) (requestID uint8, err error)
Parameter:
  • slaveAddress – Typ: uint8, Wertebereich: [0 bis 247]
  • startingAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • count – Typ: uint16, Wertebereich: [1 bis 125]
Rückgabe:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Im Modbus-Master Modus kann diese Funktion genutzt werden un eine Read Holding Register-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 3).

  • Slave Address: Addresse des anzusprechenden Modbus-Slave.
  • Starting Address: Nummer des ersten zu lesenden Holding Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) ist implizit und muss ausgelassen werden.
  • Count: Anzahl der zu lesenden Register.

Nach erfolgreichem Ausführen der Leseoperation gibt diese Funktion eine Request ID zurück, die nicht 0 ist. Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

Falls kein Fehler auftritt, wird auch der RegisterModbusMasterReadHoldingRegistersResponseCallback Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

func (*RS485Bricklet) ModbusSlaveAnswerWriteSingleCoilRequest(requestID uint8) (err error)
Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Im Modbus-Slave Modus kann diese Funktion genutzt werden un eine Read Single Coil-Anfrage eines Modbus-Masters zu beantworten.

  • Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom RegisterModbusSlaveWriteSingleCoilRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

func (*RS485Bricklet) ModbusMasterWriteSingleCoil(slaveAddress uint8, coilAddress uint32, coilValue bool) (requestID uint8, err error)
Parameter:
  • slaveAddress – Typ: uint8, Wertebereich: [0 bis 247]
  • coilAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • coilValue – Typ: bool
Rückgabe:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Im Modbus-Master Modus kann diese Funktion genutzt werden un eine einzelne Coil eines Modbus-Slave zu schreiben (Modbus Funktionscode 5).

  • Slave Address: Addresse des anzusprechenden Modbus-Slave.
  • Coil Address: Nummer der zu schreibenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.
  • Coil Value: Zu schreibender Wert

Falls kein Fehler auftritt, wird auch der RegisterModbusMasterWriteSingleCoilResponseCallback Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

func (*RS485Bricklet) ModbusSlaveAnswerWriteSingleRegisterRequest(requestID uint8) (err error)
Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Im Modbus-Slave Modus kann diese Funktion genutzt werden un eine Write Single Register-Anfrage eines Modbus-Masters zu beantworten.

  • Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom RegisterModbusSlaveWriteSingleRegisterRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

func (*RS485Bricklet) ModbusMasterWriteSingleRegister(slaveAddress uint8, registerAddress uint32, registerValue uint16) (requestID uint8, err error)
Parameter:
  • slaveAddress – Typ: uint8, Wertebereich: [0 bis 247]
  • registerAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • registerValue – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Im Modbus-Master Modus kann diese Funktion genutzt werden un ein einzelnes Register eines Modbus-Slave zu schreiben (Modbus Funktionscode 6).

  • Slave Address: Addresse des anzusprechenden Modbus-Slave.
  • Register Address: Nummer des zu schreibenden Holding Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) ist implizit und muss ausgelassen werden.
  • Register Value: Zu schreibender Wert

Falls kein Fehler auftritt, wird auch der RegisterModbusMasterWriteSingleRegisterResponseCallback Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

func (*RS485Bricklet) ModbusSlaveAnswerWriteMultipleCoilsRequest(requestID uint8) (err error)
Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Im Modbus-Slave Modus kann diese Funktion genutzt werden un eine Write Multiple Coils-Anfrage eines Modbus-Masters zu beantworten.

  • Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom RegisterModbusSlaveWriteMultipleCoilsRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

func (*RS485Bricklet) ModbusMasterWriteMultipleCoils(slaveAddress uint8, startingAddress uint32, coils []bool) (requestID uint8, err error)
Parameter:
  • slaveAddress – Typ: uint8, Wertebereich: [0 bis 247]
  • startingAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • coils – Typ: []bool, Länge: variabel
Rückgabe:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Im Modbus-Master Modus kann diese Funktion genutzt werden un eine mehrere Coils eines Modbus-Slave zu schreiben (Modbus Funktionscode 15).

  • Slave Address: Addresse des anzusprechenden Modbus-Slave.
  • Starting Address: Nummer der ersten zu schreibenden Coil. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Falls kein Fehler auftritt, wird auch der RegisterModbusMasterWriteMultipleCoilsResponseCallback Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

func (*RS485Bricklet) ModbusSlaveAnswerWriteMultipleRegistersRequest(requestID uint8) (err error)
Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • err – Typ: error

Im Modbus-Slave Modus kann diese Funktion genutzt werden un eine Write Multiple Register-Anfrage eines Modbus-Masters zu beantworten.

  • Request ID: Request ID der zu beantwortenden Anfrage.

Diese Funktion muss vom RegisterModbusSlaveWriteMultipleRegistersRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

func (*RS485Bricklet) ModbusMasterWriteMultipleRegisters(slaveAddress uint8, startingAddress uint32, registers []uint16) (requestID uint8, err error)
Parameter:
  • slaveAddress – Typ: uint8, Wertebereich: [0 bis 247]
  • startingAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • registers – Typ: []uint16, Länge: variabel, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Im Modbus-Master Modus kann diese Funktion genutzt werden um ein oder mehrere Holding Register eines Modbus-Slave zu schreiben (Modbus Funktionscode 16).

  • Slave Address: Addresse des anzusprechenden Modbus-Slave.
  • Starting Address: Nummer des ersten zu schreibenden Holding Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) ist implizit und muss ausgelassen werden.

Falls kein Fehler auftritt, wird auch der RegisterModbusMasterWriteMultipleRegistersResponseCallback Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwort auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Fehlerfall ist die Request ID 0.

func (*RS485Bricklet) ModbusSlaveAnswerReadDiscreteInputsRequest(requestID uint8, discreteInputs []bool) (err error)
Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • discreteInputs – Typ: []bool, Länge: variabel
Rückgabe:
  • err – Typ: error

Im Modbus-Slave Modus kann diese Funktion genutzt werden un eine Read Discrete Inputs-Anfrage eines Modbus-Masters zu beantworten.

  • Request ID: Request ID der zu beantwortenden Anfrage.
  • Discrete Inputs: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom RegisterModbusSlaveReadDiscreteInputsRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

func (*RS485Bricklet) ModbusMasterReadDiscreteInputs(slaveAddress uint8, startingAddress uint32, count uint16) (requestID uint8, err error)
Parameter:
  • slaveAddress – Typ: uint8, Wertebereich: [0 bis 247]
  • startingAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • count – Typ: uint16, Wertebereich: [1 bis 2000]
Rückgabe:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Im Modbus-Master Modus kann diese Funktion genutzt werden un eine Read Discrete Inputs-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 2).

  • Slave Address: Addresse des anzusprechenden Modbus-Slave.
  • Starting Address: Nummer des ersten zu lesenden Discrete Inputs. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Discrete-Input-Nummer zwischen 1 und 65536. Die Präfixziffer 1 (für Discrete Input) ist implizit und muss ausgelassen werden.
  • Count: Anzahl der zu lesenden Register.

Falls kein Fehler auftritt, wird auch der RegisterModbusMasterReadDiscreteInputsResponseCallback Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwortet auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

func (*RS485Bricklet) ModbusSlaveAnswerReadInputRegistersRequest(requestID uint8, inputRegisters []uint16) (err error)
Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • inputRegisters – Typ: []uint16, Länge: variabel, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • err – Typ: error

Im Modbus-Slave Modus kann diese Funktion genutzt werden un eine Read Input-Anfrage eines Modbus-Masters zu beantworten.

  • Request ID: Request ID der zu beantwortenden Anfrage.
  • Input Registers: Daten die zum Modbus-Master gesendet werden sollen.

Diese Funktion muss vom RegisterModbusSlaveReadInputRegistersRequestCallback Callback mit der Request ID des Callbacks aufgerufen werden.

func (*RS485Bricklet) ModbusMasterReadInputRegisters(slaveAddress uint8, startingAddress uint32, count uint16) (requestID uint8, err error)
Parameter:
  • slaveAddress – Typ: uint8, Wertebereich: [0 bis 247]
  • startingAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • count – Typ: uint16, Wertebereich: [1 bis 125]
Rückgabe:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: error

Im Modbus-Master Modus kann diese Funktion genutzt werden un eine Read Input-Anfrage an einen Modbus-Slave zu senden (Modbus Funktionscode 4).

  • Slave Address: Addresse des anzusprechenden Modbus-Slave.
  • Starting Address: Nummer der ersten zu lesenden Input Registers. Aus Gründen der Rückwärtskompatibilität heißt dieser Parameter Starting Address, ist aber keine Addresse, sondern eine eins-basierte Input-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 3 (für Input Register) ist implizit und muss ausgelassen werden.
  • Count: Anzahl der zu lesenden Register.

Falls kein Fehler auftritt, wird auch der RegisterModbusMasterReadInputRegistersResponseCallback Callback aufgerufen. In diesem Callback wird einer Request ID übergeben. Falls der Callback eine Antwortet auf diese Anfrage ist, stimmt die Request ID mit der in dieser Funktion zurückgegeben Request ID überein.

Im Falle eines Fehlers wird eine 0 als Request ID zurückgegeben.

func (*RS485Bricklet) GetSPITFPErrorCount() (errorCountAckChecksum uint32, errorCountMessageChecksum uint32, errorCountFrame uint32, errorCountOverflow uint32, err error)
Rückgabe:
  • errorCountAckChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: 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 (*RS485Bricklet) SetBootloaderMode(mode uint8) (status uint8, err error)
Parameter:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: 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 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:

  • rs485_bricklet.BootloaderModeBootloader = 0
  • rs485_bricklet.BootloaderModeFirmware = 1
  • rs485_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • rs485_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • rs485_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4

Für status:

  • rs485_bricklet.BootloaderStatusOK = 0
  • rs485_bricklet.BootloaderStatusInvalidMode = 1
  • rs485_bricklet.BootloaderStatusNoChange = 2
  • rs485_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • rs485_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • rs485_bricklet.BootloaderStatusCRCMismatch = 5
func (*RS485Bricklet) GetBootloaderMode() (mode uint8, err error)
Rückgabe:
  • mode – Typ: uint8, Wertebereich: Siehe Konstanten
  • err – Typ: error

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

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

Für mode:

  • rs485_bricklet.BootloaderModeBootloader = 0
  • rs485_bricklet.BootloaderModeFirmware = 1
  • rs485_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • rs485_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • rs485_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*RS485Bricklet) SetWriteFirmwarePointer(pointer uint32) (err error)
Parameter:
  • pointer – Typ: uint32, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: 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 (*RS485Bricklet) WriteFirmware(data [64]uint8) (status uint8, err error)
Parameter:
  • data – Typ: [64]uint8, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: uint8, Wertebereich: [0 bis 255]
  • err – Typ: 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 (*RS485Bricklet) SetStatusLEDConfig(config uint8) (err error)
Parameter:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: 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:

Für config:

  • rs485_bricklet.StatusLEDConfigOff = 0
  • rs485_bricklet.StatusLEDConfigOn = 1
  • rs485_bricklet.StatusLEDConfigShowHeartbeat = 2
  • rs485_bricklet.StatusLEDConfigShowStatus = 3
func (*RS485Bricklet) GetStatusLEDConfig() (config uint8, err error)
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

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

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

Für config:

  • rs485_bricklet.StatusLEDConfigOff = 0
  • rs485_bricklet.StatusLEDConfigOn = 1
  • rs485_bricklet.StatusLEDConfigShowHeartbeat = 2
  • rs485_bricklet.StatusLEDConfigShowStatus = 3
func (*RS485Bricklet) GetChipTemperature() (temperature int16, err error)
Rückgabe:
  • temperature – Typ: int16, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]
  • err – Typ: error

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.

func (*RS485Bricklet) Reset() (err error)
Rückgabe:
  • err – Typ: 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 (*RS485Bricklet) WriteUID(uid uint32) (err error)
Parameter:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • err – Typ: 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 (*RS485Bricklet) ReadUID() (uid uint32, err error)
Rückgabe:
  • uid – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: 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 (*RS485Bricklet) 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 (*RS485Bricklet) EnableReadCallback() (err error)
Rückgabe:
  • err – Typ: error

Aktiviert den RegisterReadCallback Callback.

Im Startzustand ist der Callback deaktiviert.

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

Deaktiviert den RegisterReadCallback Callback.

Im Startzustand ist der Callback deaktiviert.

func (*RS485Bricklet) 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.

func (*RS485Bricklet) EnableErrorCountCallback() (err error)
Rückgabe:
  • err – Typ: error

Aktiviert den RegisterErrorCountCallback Callback.

Im Startzustand ist der Callback deaktiviert.

func (*RS485Bricklet) DisableErrorCountCallback() (err error)
Rückgabe:
  • err – Typ: error

Deaktiviert den RegisterErrorCountCallback Callback.

Im Startzustand ist der Callback deaktiviert.

func (*RS485Bricklet) IsErrorCountCallbackEnabled() (enabled bool, err error)
Rückgabe:
  • enabled – Typ: bool, Standardwert: true
  • err – Typ: error

Gibt true zurück falls RegisterErrorCountCallback 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 (*RS485Bricklet) RegisterReadCallback(func(message []rune)) (registrationId uint64)
Callback-Parameter:
  • message – Typ: []rune, Länge: variabel
Rückgabe:
  • registrationId – Typ: uint64

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.

func (*RS485Bricklet) RegisterErrorCountCallback(func(overrunErrorCount uint32, parityErrorCount uint32)) (registrationId uint64)
Callback-Parameter:
  • overrunErrorCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • parityErrorCount – Typ: uint32, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • registrationId – Typ: uint64

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

func (*RS485Bricklet) RegisterModbusSlaveReadCoilsRequestCallback(func(requestID uint8, startingAddress uint32, count uint16)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • startingAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • count – Typ: uint16, Wertebereich: [1 bis 2000]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Coils erhält. Die Parameter des Callbacks sind die Request ID der Anfrage, die Nummer der ersten zu lesenden Coil und die Anzahl der zu lesenden Coils. Die Nummer der ersten Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion ModbusSlaveAnswerReadCoilsRequest() gesendet werden.

func (*RS485Bricklet) RegisterModbusMasterReadCoilsResponseCallback(func(coils []bool, requestID uint8, exceptionCode int8)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: int8, Wertebereich: Siehe Konstanten
  • coils – Typ: []bool, Länge: variabel
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Coils-Anfrage zurück bekommt.

Die Parameter des Callbacks sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Ein Exception Code der nicht 0 ist, beschreibt einen Fehler. Wenn die Zahl größer 0 ist, entspricht der Code dem Modbus Exception Code. Wenn die Zahl kleiner 0 ist, ist ein anderer Fehler aufgetreten. Ein Wert von -1 bedeutet, dass es einen Timeout bei der Anfrage gab. Die Länge dieses Timeouts kann per SetModbusConfiguration() gesetzt werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit nil für coils ausgelöst.

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

Für exceptionCode:

  • rs485_bricklet.ExceptionCodeTimeout = -1
  • rs485_bricklet.ExceptionCodeSuccess = 0
  • rs485_bricklet.ExceptionCodeIllegalFunction = 1
  • rs485_bricklet.ExceptionCodeIllegalDataAddress = 2
  • rs485_bricklet.ExceptionCodeIllegalDataValue = 3
  • rs485_bricklet.ExceptionCodeSlaveDeviceFailure = 4
  • rs485_bricklet.ExceptionCodeAcknowledge = 5
  • rs485_bricklet.ExceptionCodeSlaveDeviceBusy = 6
  • rs485_bricklet.ExceptionCodeMemoryParityError = 8
  • rs485_bricklet.ExceptionCodeGatewayPathUnavailable = 10
  • rs485_bricklet.ExceptionCodeGatewayTargetDeviceFailedToRespond = 11
func (*RS485Bricklet) RegisterModbusSlaveReadHoldingRegistersRequestCallback(func(requestID uint8, startingAddress uint32, count uint16)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • startingAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • count – Typ: uint16, Wertebereich: [1 bis 125]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Holding Registern erhält. Die Parameter des Callbacks sind die Request ID der Anfrage, die Nummer des ersten zu lesenden Holding Registers und die Anzahl der zu lesenden Register. Die Nummer des ersten Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion ModbusSlaveAnswerReadHoldingRegistersRequest() gesendet werden.

func (*RS485Bricklet) RegisterModbusMasterReadHoldingRegistersResponseCallback(func(holdingRegisters []uint16, requestID uint8, exceptionCode int8)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: int8, Wertebereich: Siehe Konstanten
  • holdingRegisters – Typ: []uint16, Länge: variabel, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Holding Registers-Anfrage zurück bekommt.

Die Parameter des Callbacks sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Ein Exception Code der nicht 0 ist, beschreibt einen Fehler. Wenn die Zahl größer 0 ist, entspricht der Code dem Modbus Exception Code. Wenn die Zahl kleiner 0 ist, ist ein anderer Fehler aufgetreten. Ein Wert von -1 bedeutet, dass es einen Timeout bei der Anfrage gab. Die Länge dieses Timeouts kann per SetModbusConfiguration() gesetzt werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit nil für holdingRegisters ausgelöst.

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

Für exceptionCode:

  • rs485_bricklet.ExceptionCodeTimeout = -1
  • rs485_bricklet.ExceptionCodeSuccess = 0
  • rs485_bricklet.ExceptionCodeIllegalFunction = 1
  • rs485_bricklet.ExceptionCodeIllegalDataAddress = 2
  • rs485_bricklet.ExceptionCodeIllegalDataValue = 3
  • rs485_bricklet.ExceptionCodeSlaveDeviceFailure = 4
  • rs485_bricklet.ExceptionCodeAcknowledge = 5
  • rs485_bricklet.ExceptionCodeSlaveDeviceBusy = 6
  • rs485_bricklet.ExceptionCodeMemoryParityError = 8
  • rs485_bricklet.ExceptionCodeGatewayPathUnavailable = 10
  • rs485_bricklet.ExceptionCodeGatewayTargetDeviceFailedToRespond = 11
func (*RS485Bricklet) RegisterModbusSlaveWriteSingleCoilRequestCallback(func(requestID uint8, coilAddress uint32, coilValue bool)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • coilAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • coilValue – Typ: bool
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer einzelnen Coil erhält. Die Parameter des Callbacks sind die Request ID der Anfrage, die Nummer der Coil und der Wert der zu schreibenen Coil. Die Nummer der Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion ModbusSlaveAnswerWriteSingleCoilRequest() gesendet werden.

func (*RS485Bricklet) RegisterModbusMasterWriteSingleCoilResponseCallback(func(requestID uint8, exceptionCode int8)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: int8, Wertebereich: Siehe Konstanten
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Single Coil-Anfrage zurück bekommt.

Die Parameter des Callbacks sind die Request ID der Anfrage und der Exception Code der Antwort.

Ein Exception Code der nicht 0 ist, beschreibt einen Fehler. Wenn die Zahl größer 0 ist, entspricht der Code dem Modbus Exception Code. Wenn die Zahl kleiner 0 ist, ist ein anderer Fehler aufgetreten. Ein Wert von -1 bedeutet, dass es einen Timeout bei der Anfrage gab. Die Länge dieses Timeouts kann per SetModbusConfiguration() gesetzt werden.

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

Für exceptionCode:

  • rs485_bricklet.ExceptionCodeTimeout = -1
  • rs485_bricklet.ExceptionCodeSuccess = 0
  • rs485_bricklet.ExceptionCodeIllegalFunction = 1
  • rs485_bricklet.ExceptionCodeIllegalDataAddress = 2
  • rs485_bricklet.ExceptionCodeIllegalDataValue = 3
  • rs485_bricklet.ExceptionCodeSlaveDeviceFailure = 4
  • rs485_bricklet.ExceptionCodeAcknowledge = 5
  • rs485_bricklet.ExceptionCodeSlaveDeviceBusy = 6
  • rs485_bricklet.ExceptionCodeMemoryParityError = 8
  • rs485_bricklet.ExceptionCodeGatewayPathUnavailable = 10
  • rs485_bricklet.ExceptionCodeGatewayTargetDeviceFailedToRespond = 11
func (*RS485Bricklet) RegisterModbusSlaveWriteSingleRegisterRequestCallback(func(requestID uint8, registerAddress uint32, registerValue uint16)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • registerAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • registerValue – Typ: uint16, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer einzelnen Holding Registers erhält. Die Parameter des Callbacks sind die Request ID der Anfrage, die Nummer des Holding Registers und der Wert des zuschreibenen Registers. Die Nummer des Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion ModbusSlaveAnswerWriteSingleRegisterRequest() gesendet werden.

func (*RS485Bricklet) RegisterModbusMasterWriteSingleRegisterResponseCallback(func(requestID uint8, exceptionCode int8)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: int8, Wertebereich: Siehe Konstanten
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Single Register-Anfrage zurück bekommt.

Die Parameter des Callbacks sind die Request ID der Anfrage und der Exception Code der Antwort.

Ein Exception Code der nicht 0 ist, beschreibt einen Fehler. Wenn die Zahl größer 0 ist, entspricht der Code dem Modbus Exception Code. Wenn die Zahl kleiner 0 ist, ist ein anderer Fehler aufgetreten. Ein Wert von -1 bedeutet, dass es einen Timeout bei der Anfrage gab. Die Länge dieses Timeouts kann per SetModbusConfiguration() gesetzt werden.

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

Für exceptionCode:

  • rs485_bricklet.ExceptionCodeTimeout = -1
  • rs485_bricklet.ExceptionCodeSuccess = 0
  • rs485_bricklet.ExceptionCodeIllegalFunction = 1
  • rs485_bricklet.ExceptionCodeIllegalDataAddress = 2
  • rs485_bricklet.ExceptionCodeIllegalDataValue = 3
  • rs485_bricklet.ExceptionCodeSlaveDeviceFailure = 4
  • rs485_bricklet.ExceptionCodeAcknowledge = 5
  • rs485_bricklet.ExceptionCodeSlaveDeviceBusy = 6
  • rs485_bricklet.ExceptionCodeMemoryParityError = 8
  • rs485_bricklet.ExceptionCodeGatewayPathUnavailable = 10
  • rs485_bricklet.ExceptionCodeGatewayTargetDeviceFailedToRespond = 11
func (*RS485Bricklet) RegisterModbusSlaveWriteMultipleCoilsRequestCallback(func(coils []bool, requestID uint8, startingAddress uint32)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • startingAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • coils – Typ: []bool, Länge: variabel
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer mehrerer Coils erhält. Die Parameter des Callbacks sind die Request ID der Anfrage, die Nummer der ersten Coil und die zu schreibenen Daten. Die Nummer der ersten Coil heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Coil-Nummer zwischen 1 und 65536.

Eine Antwort auf diese Anfrage kann mit der Funktion ModbusSlaveAnswerWriteMultipleCoilsRequest() gesendet werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit nil für coils ausgelöst.

func (*RS485Bricklet) RegisterModbusMasterWriteMultipleCoilsResponseCallback(func(requestID uint8, exceptionCode int8)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: int8, Wertebereich: Siehe Konstanten
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Multiple Coils-Anfrage zurück bekommt.

Die Parameter des Callbacks sind die Request ID der Anfrage und der Exception Code der Antwort.

Ein Exception Code der nicht 0 ist, beschreibt einen Fehler. Wenn die Zahl größer 0 ist, entspricht der Code dem Modbus Exception Code. Wenn die Zahl kleiner 0 ist, ist ein anderer Fehler aufgetreten. Ein Wert von -1 bedeutet, dass es einen Timeout bei der Anfrage gab. Die Länge dieses Timeouts kann per SetModbusConfiguration() gesetzt werden.

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

Für exceptionCode:

  • rs485_bricklet.ExceptionCodeTimeout = -1
  • rs485_bricklet.ExceptionCodeSuccess = 0
  • rs485_bricklet.ExceptionCodeIllegalFunction = 1
  • rs485_bricklet.ExceptionCodeIllegalDataAddress = 2
  • rs485_bricklet.ExceptionCodeIllegalDataValue = 3
  • rs485_bricklet.ExceptionCodeSlaveDeviceFailure = 4
  • rs485_bricklet.ExceptionCodeAcknowledge = 5
  • rs485_bricklet.ExceptionCodeSlaveDeviceBusy = 6
  • rs485_bricklet.ExceptionCodeMemoryParityError = 8
  • rs485_bricklet.ExceptionCodeGatewayPathUnavailable = 10
  • rs485_bricklet.ExceptionCodeGatewayTargetDeviceFailedToRespond = 11
func (*RS485Bricklet) RegisterModbusSlaveWriteMultipleRegistersRequestCallback(func(registers []uint16, requestID uint8, startingAddress uint32)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • startingAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • registers – Typ: []uint16, Länge: variabel, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum schreiben einer mehrerer Holding Register erhält. Die Parameter des Callbacks sind die Request ID der Anfrage, die Nummer des ersten Holding Registers und die zu schreibenen Daten. Die Nummer des ersten Holding Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Holding-Register-Nummer zwischen 1 und 65536. Die Präfixziffer 4 (für Holding Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion ModbusSlaveAnswerWriteMultipleRegistersRequest() gesendet werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit nil für registers ausgelöst.

func (*RS485Bricklet) RegisterModbusMasterWriteMultipleRegistersResponseCallback(func(requestID uint8, exceptionCode int8)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: int8, Wertebereich: Siehe Konstanten
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Write Multiple Register-Anfrage zurück bekommt.

Die Parameter des Callbacks sind die Request ID der Anfrage und der Exception Code der Antwort.

Ein Exception Code der nicht 0 ist, beschreibt einen Fehler. Wenn die Zahl größer 0 ist, entspricht der Code dem Modbus Exception Code. Wenn die Zahl kleiner 0 ist, ist ein anderer Fehler aufgetreten. Ein Wert von -1 bedeutet, dass es einen Timeout bei der Anfrage gab. Die Länge dieses Timeouts kann per SetModbusConfiguration() gesetzt werden.

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

Für exceptionCode:

  • rs485_bricklet.ExceptionCodeTimeout = -1
  • rs485_bricklet.ExceptionCodeSuccess = 0
  • rs485_bricklet.ExceptionCodeIllegalFunction = 1
  • rs485_bricklet.ExceptionCodeIllegalDataAddress = 2
  • rs485_bricklet.ExceptionCodeIllegalDataValue = 3
  • rs485_bricklet.ExceptionCodeSlaveDeviceFailure = 4
  • rs485_bricklet.ExceptionCodeAcknowledge = 5
  • rs485_bricklet.ExceptionCodeSlaveDeviceBusy = 6
  • rs485_bricklet.ExceptionCodeMemoryParityError = 8
  • rs485_bricklet.ExceptionCodeGatewayPathUnavailable = 10
  • rs485_bricklet.ExceptionCodeGatewayTargetDeviceFailedToRespond = 11
func (*RS485Bricklet) RegisterModbusSlaveReadDiscreteInputsRequestCallback(func(requestID uint8, startingAddress uint32, count uint16)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • startingAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • count – Typ: uint16, Wertebereich: [1 bis 2000]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Discrete Inputs erhält. Die Parameter des Callbacks sind die Request ID der Anfrage, die Nummer des ersten Discrete Inputs und die Anzahl der zu lesenden Discrete Inputs. Die Nummer des ersten Discrete Inputs heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Discrete Input-Nummer zwischen 1 und 65536. Die Präfixziffer 1 (für Discrete Input) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion ModbusSlaveAnswerReadDiscreteInputsRequest() gesendet werden.

func (*RS485Bricklet) RegisterModbusMasterReadDiscreteInputsResponseCallback(func(discreteInputs []bool, requestID uint8, exceptionCode int8)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: int8, Wertebereich: Siehe Konstanten
  • discreteInputs – Typ: []bool, Länge: variabel
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Discrete Inputs-Anfrage zurück bekommt.

Die Parameter des Callbacks sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Ein Exception Code der nicht 0 ist, beschreibt einen Fehler. Wenn die Zahl größer 0 ist, entspricht der Code dem Modbus Exception Code. Wenn die Zahl kleiner 0 ist, ist ein anderer Fehler aufgetreten. Ein Wert von -1 bedeutet, dass es einen Timeout bei der Anfrage gab. Die Länge dieses Timeouts kann per SetModbusConfiguration() gesetzt werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit nil für discreteInputs ausgelöst.

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

Für exceptionCode:

  • rs485_bricklet.ExceptionCodeTimeout = -1
  • rs485_bricklet.ExceptionCodeSuccess = 0
  • rs485_bricklet.ExceptionCodeIllegalFunction = 1
  • rs485_bricklet.ExceptionCodeIllegalDataAddress = 2
  • rs485_bricklet.ExceptionCodeIllegalDataValue = 3
  • rs485_bricklet.ExceptionCodeSlaveDeviceFailure = 4
  • rs485_bricklet.ExceptionCodeAcknowledge = 5
  • rs485_bricklet.ExceptionCodeSlaveDeviceBusy = 6
  • rs485_bricklet.ExceptionCodeMemoryParityError = 8
  • rs485_bricklet.ExceptionCodeGatewayPathUnavailable = 10
  • rs485_bricklet.ExceptionCodeGatewayTargetDeviceFailedToRespond = 11
func (*RS485Bricklet) RegisterModbusSlaveReadInputRegistersRequestCallback(func(requestID uint8, startingAddress uint32, count uint16)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • startingAddress – Typ: uint32, Wertebereich: [1 bis 65536]
  • count – Typ: uint16, Wertebereich: [1 bis 125]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Slave Modus aufgerufen, wenn der Slave eine gültige Anfrage eines Masters zum lesen von Input Registern erhält. Die Parameter des Callbacks sind die Request ID der Anfrage, die Nummer des ersten Input Registers und die Anzahl der zu lesenden Register. Die Nummer des ersten Input Registers heißt aus Rückwärtskompatiblitätsgründen starting address. Sie ist keine Adresse, sondern eine eins-basierte Input Register-Nummer zwischen 1 und 65536. Die Präfixziffer 3 (für Input Register) wird ausgelassen.

Eine Antwort auf diese Anfrage kann mit der Funktion ModbusSlaveAnswerReadInputRegistersRequest() gesendet werden.

func (*RS485Bricklet) RegisterModbusMasterReadInputRegistersResponseCallback(func(inputRegisters []uint16, requestID uint8, exceptionCode int8)) (registrationId uint64)
Callback-Parameter:
  • requestID – Typ: uint8, Wertebereich: [0 bis 255]
  • exceptionCode – Typ: int8, Wertebereich: Siehe Konstanten
  • inputRegisters – Typ: []uint16, Länge: variabel, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird im Modbus-Master Modus aufgerufen, wenn der Master eine gültige Antwort auf eine Read Input Registers-Anfrage zurück bekommt.

Die Parameter des Callbacks sind die Request ID der Anfrage, der Exception Code der Antwort und die empfangenen Daten.

Ein Exception Code der nicht 0 ist, beschreibt einen Fehler. Wenn die Zahl größer 0 ist, entspricht der Code dem Modbus Exception Code. Wenn die Zahl kleiner 0 ist, ist ein anderer Fehler aufgetreten. Ein Wert von -1 bedeutet, dass es einen Timeout bei der Anfrage gab. Die Länge dieses Timeouts kann per SetModbusConfiguration() gesetzt werden.

Bemerkung

Falls das Rekonstruieren des Wertes fehlschlägt, wird der Callback mit nil für inputRegisters ausgelöst.

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

Für exceptionCode:

  • rs485_bricklet.ExceptionCodeTimeout = -1
  • rs485_bricklet.ExceptionCodeSuccess = 0
  • rs485_bricklet.ExceptionCodeIllegalFunction = 1
  • rs485_bricklet.ExceptionCodeIllegalDataAddress = 2
  • rs485_bricklet.ExceptionCodeIllegalDataValue = 3
  • rs485_bricklet.ExceptionCodeSlaveDeviceFailure = 4
  • rs485_bricklet.ExceptionCodeAcknowledge = 5
  • rs485_bricklet.ExceptionCodeSlaveDeviceBusy = 6
  • rs485_bricklet.ExceptionCodeMemoryParityError = 8
  • rs485_bricklet.ExceptionCodeGatewayPathUnavailable = 10
  • rs485_bricklet.ExceptionCodeGatewayTargetDeviceFailedToRespond = 11

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 (*RS485Bricklet) 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 (*RS485Bricklet) 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:

  • rs485_bricklet.FunctionEnableReadCallback = 3
  • rs485_bricklet.FunctionDisableReadCallback = 4
  • rs485_bricklet.FunctionSetRS485Configuration = 6
  • rs485_bricklet.FunctionSetModbusConfiguration = 8
  • rs485_bricklet.FunctionSetMode = 10
  • rs485_bricklet.FunctionSetCommunicationLEDConfig = 12
  • rs485_bricklet.FunctionSetErrorLEDConfig = 14
  • rs485_bricklet.FunctionSetBufferConfig = 16
  • rs485_bricklet.FunctionEnableErrorCountCallback = 19
  • rs485_bricklet.FunctionDisableErrorCountCallback = 20
  • rs485_bricklet.FunctionModbusSlaveReportException = 24
  • rs485_bricklet.FunctionModbusSlaveAnswerReadCoilsRequest = 25
  • rs485_bricklet.FunctionModbusSlaveAnswerReadHoldingRegistersRequest = 27
  • rs485_bricklet.FunctionModbusSlaveAnswerWriteSingleCoilRequest = 29
  • rs485_bricklet.FunctionModbusSlaveAnswerWriteSingleRegisterRequest = 31
  • rs485_bricklet.FunctionModbusSlaveAnswerWriteMultipleCoilsRequest = 33
  • rs485_bricklet.FunctionModbusSlaveAnswerWriteMultipleRegistersRequest = 35
  • rs485_bricklet.FunctionModbusSlaveAnswerReadDiscreteInputsRequest = 37
  • rs485_bricklet.FunctionModbusSlaveAnswerReadInputRegistersRequest = 39
  • rs485_bricklet.FunctionSetWriteFirmwarePointer = 237
  • rs485_bricklet.FunctionSetStatusLEDConfig = 239
  • rs485_bricklet.FunctionReset = 243
  • rs485_bricklet.FunctionWriteUID = 248
func (*RS485Bricklet) 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:

  • rs485_bricklet.FunctionEnableReadCallback = 3
  • rs485_bricklet.FunctionDisableReadCallback = 4
  • rs485_bricklet.FunctionSetRS485Configuration = 6
  • rs485_bricklet.FunctionSetModbusConfiguration = 8
  • rs485_bricklet.FunctionSetMode = 10
  • rs485_bricklet.FunctionSetCommunicationLEDConfig = 12
  • rs485_bricklet.FunctionSetErrorLEDConfig = 14
  • rs485_bricklet.FunctionSetBufferConfig = 16
  • rs485_bricklet.FunctionEnableErrorCountCallback = 19
  • rs485_bricklet.FunctionDisableErrorCountCallback = 20
  • rs485_bricklet.FunctionModbusSlaveReportException = 24
  • rs485_bricklet.FunctionModbusSlaveAnswerReadCoilsRequest = 25
  • rs485_bricklet.FunctionModbusSlaveAnswerReadHoldingRegistersRequest = 27
  • rs485_bricklet.FunctionModbusSlaveAnswerWriteSingleCoilRequest = 29
  • rs485_bricklet.FunctionModbusSlaveAnswerWriteSingleRegisterRequest = 31
  • rs485_bricklet.FunctionModbusSlaveAnswerWriteMultipleCoilsRequest = 33
  • rs485_bricklet.FunctionModbusSlaveAnswerWriteMultipleRegistersRequest = 35
  • rs485_bricklet.FunctionModbusSlaveAnswerReadDiscreteInputsRequest = 37
  • rs485_bricklet.FunctionModbusSlaveAnswerReadInputRegistersRequest = 39
  • rs485_bricklet.FunctionSetWriteFirmwarePointer = 237
  • rs485_bricklet.FunctionSetStatusLEDConfig = 239
  • rs485_bricklet.FunctionReset = 243
  • rs485_bricklet.FunctionWriteUID = 248
func (*RS485Bricklet) 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

rs485_bricklet.DeviceIdentifier

Diese Konstante wird verwendet um ein RS485 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.

rs485_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines RS485 Bricklet dar.