Go - Industrial Counter Bricklet

Dies ist die Beschreibung der Go API Bindings für das Industrial Counter Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Counter 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).

Callback

Download (example_callback.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
package main

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

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

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

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

    ic.RegisterAllCounterCallback(func(counter [4]int64) {
        fmt.Printf("Counter (Channel 0): %d\n", counter[0])
        fmt.Printf("Counter (Channel 1): %d\n", counter[1])
        fmt.Printf("Counter (Channel 2): %d\n", counter[2])
        fmt.Printf("Counter (Channel 3): %d\n", counter[3])
        fmt.Println()
    })

    // Set period for all counter callback to 1s (1000ms).
    ic.SetAllCounterCallbackConfiguration(1000, true)

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

Simple

Download (example_simple.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/industrial_counter_bricklet"
    "github.com/Tinkerforge/go-api-bindings/ipconnection"
)

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

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

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

    // Get current counter from channel 0.
    counter, _ := ic.GetCounter(industrial_counter_bricklet.Channel0)
    fmt.Printf("Counter (Channel 0): \n", counter)

    // Get current signal data from channel 0.
    dutyCycle, period, frequency, value, _ := ic.GetSignalData(industrial_counter_bricklet.Channel0)

    fmt.Printf("Duty Cycle (Channel 0): %f %%\n", float64(dutyCycle)/100.0)
    fmt.Printf("Period (Channel 0):  ns\n", period)
    fmt.Printf("Frequency (Channel 0): %f Hz\n", float64(frequency)/1000.0)
    fmt.Printf("Value (Channel 0): \n", value)

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

API

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

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

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

Dieses Geräteobjekt kann benutzt werden, nachdem die IPConnection verbunden.

func (*IndustrialCounterBricklet) GetCounter(channel uint8) (counter int64, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • counter – Typ: int64, Wertebereich: [-247 bis 247 - 1]
  • err – Typ: error

Gibt den aktuellen Zählerstand für den gegebenen Kanal zurück.

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

Für channel:

  • industrial_counter_bricklet.Channel0 = 0
  • industrial_counter_bricklet.Channel1 = 1
  • industrial_counter_bricklet.Channel2 = 2
  • industrial_counter_bricklet.Channel3 = 3
func (*IndustrialCounterBricklet) GetAllCounter() (counter [4]int64, err error)
Rückgabe:
  • counter – Typ: [4]int64, Wertebereich: [-247 bis 247 - 1]
  • err – Typ: error

Gibt die Zählerstände für alle vier Kanäle zurück.

func (*IndustrialCounterBricklet) SetCounter(channel uint8, counter int64) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • counter – Typ: int64, Wertebereich: [-247 bis 247 - 1]
Rückgabe:
  • err – Typ: error

Setzt den Zählerstand für den gegebenen Kanal.

Der Standardwert für alle Zähler nach dem Start ist 0.

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

Für channel:

  • industrial_counter_bricklet.Channel0 = 0
  • industrial_counter_bricklet.Channel1 = 1
  • industrial_counter_bricklet.Channel2 = 2
  • industrial_counter_bricklet.Channel3 = 3
func (*IndustrialCounterBricklet) SetAllCounter(counter [4]int64) (err error)
Parameter:
  • counter – Typ: [4]int64, Wertebereich: [-247 bis 247 - 1]
Rückgabe:
  • err – Typ: error

Setzt die Zählerstände für alle vier Kanäle.

Der Standardwert für die Zähler nach dem Starten ist 0.

func (*IndustrialCounterBricklet) GetSignalData(channel uint8) (dutyCycle uint16, period uint64, frequency uint32, value bool, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • dutyCycle – Typ: uint16, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: uint64, Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: uint32, Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: bool
  • err – Typ: error

Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für den gegebenen Kanal.

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

Für channel:

  • industrial_counter_bricklet.Channel0 = 0
  • industrial_counter_bricklet.Channel1 = 1
  • industrial_counter_bricklet.Channel2 = 2
  • industrial_counter_bricklet.Channel3 = 3
func (*IndustrialCounterBricklet) GetAllSignalData() (dutyCycle [4]uint16, period [4]uint64, frequency [4]uint32, value [4]bool, err error)
Rückgabe:
  • dutyCycle – Typ: [4]uint16, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: [4]uint64, Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: [4]uint32, Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: [4]bool
  • err – Typ: error

Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für alle vier Kanäle zurück.

func (*IndustrialCounterBricklet) SetCounterActive(channel uint8, active bool) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • active – Typ: bool, Standardwert: true
Rückgabe:
  • err – Typ: error

Aktiviert/Deaktiviert den Zähler für den gegebenen Kanal.

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

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

Für channel:

  • industrial_counter_bricklet.Channel0 = 0
  • industrial_counter_bricklet.Channel1 = 1
  • industrial_counter_bricklet.Channel2 = 2
  • industrial_counter_bricklet.Channel3 = 3
func (*IndustrialCounterBricklet) SetAllCounterActive(active [4]bool) (err error)
Parameter:
  • active – Typ: [4]bool, Standardwert: {true, true, true, true}
Rückgabe:
  • err – Typ: error

Aktiviert/Deaktiviert den Zähler für alle vier Kanäle.

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

func (*IndustrialCounterBricklet) GetCounterActive(channel uint8) (active bool, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • active – Typ: bool, Standardwert: true
  • err – Typ: error

Gibt den Zustand (aktiviert/deaktiviert) des gegebenen Zähler zurück.

true = aktiviert, false = deaktiviert.

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

Für channel:

  • industrial_counter_bricklet.Channel0 = 0
  • industrial_counter_bricklet.Channel1 = 1
  • industrial_counter_bricklet.Channel2 = 2
  • industrial_counter_bricklet.Channel3 = 3
func (*IndustrialCounterBricklet) GetAllCounterActive() (active [4]bool, err error)
Rückgabe:
  • active – Typ: [4]bool, Standardwert: {true, true, true, true}
  • err – Typ: error

Gibt den Zustand (aktiviert/deaktiviert) aller vier Zähler zurück.

true = aktiviert, false = deaktiviert.

func (*IndustrialCounterBricklet) SetCounterConfiguration(channel uint8, countEdge uint8, countDirection uint8, dutyCyclePrescaler uint8, frequencyIntegrationTime uint8) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • countEdge – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • countDirection – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • dutyCyclePrescaler – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • frequencyIntegrationTime – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

Setzt die Zähler-Konfiguration für den gegebenen Kanal.

  • Zählflanke: Der Zähler kann bei der steigenden, fallenden oder beiden Flanken zählen.
  • Zählrichtung: Der Zähler kann hoch- oder runterzählen. Es kann auch ein weiterer Kanal als Richtungseingang genutzt werden. Siehe hier für weitere Details.
  • Tastverhältnis Prescaler: Setzt einen Teiler für die interne Clock. Siehe hier für weitere Details.
  • Frequenz-Integration: Setzt die Integrationszeit für die Frequenzmessung. Siehe hier für weitere Details.

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

Für channel:

  • industrial_counter_bricklet.Channel0 = 0
  • industrial_counter_bricklet.Channel1 = 1
  • industrial_counter_bricklet.Channel2 = 2
  • industrial_counter_bricklet.Channel3 = 3

Für countEdge:

  • industrial_counter_bricklet.CountEdgeRising = 0
  • industrial_counter_bricklet.CountEdgeFalling = 1
  • industrial_counter_bricklet.CountEdgeBoth = 2

Für countDirection:

  • industrial_counter_bricklet.CountDirectionUp = 0
  • industrial_counter_bricklet.CountDirectionDown = 1
  • industrial_counter_bricklet.CountDirectionExternalUp = 2
  • industrial_counter_bricklet.CountDirectionExternalDown = 3

Für dutyCyclePrescaler:

  • industrial_counter_bricklet.DutyCyclePrescaler1 = 0
  • industrial_counter_bricklet.DutyCyclePrescaler2 = 1
  • industrial_counter_bricklet.DutyCyclePrescaler4 = 2
  • industrial_counter_bricklet.DutyCyclePrescaler8 = 3
  • industrial_counter_bricklet.DutyCyclePrescaler16 = 4
  • industrial_counter_bricklet.DutyCyclePrescaler32 = 5
  • industrial_counter_bricklet.DutyCyclePrescaler64 = 6
  • industrial_counter_bricklet.DutyCyclePrescaler128 = 7
  • industrial_counter_bricklet.DutyCyclePrescaler256 = 8
  • industrial_counter_bricklet.DutyCyclePrescaler512 = 9
  • industrial_counter_bricklet.DutyCyclePrescaler1024 = 10
  • industrial_counter_bricklet.DutyCyclePrescaler2048 = 11
  • industrial_counter_bricklet.DutyCyclePrescaler4096 = 12
  • industrial_counter_bricklet.DutyCyclePrescaler8192 = 13
  • industrial_counter_bricklet.DutyCyclePrescaler16384 = 14
  • industrial_counter_bricklet.DutyCyclePrescaler32768 = 15

Für frequencyIntegrationTime:

  • industrial_counter_bricklet.FrequencyIntegrationTime128MS = 0
  • industrial_counter_bricklet.FrequencyIntegrationTime256MS = 1
  • industrial_counter_bricklet.FrequencyIntegrationTime512MS = 2
  • industrial_counter_bricklet.FrequencyIntegrationTime1024MS = 3
  • industrial_counter_bricklet.FrequencyIntegrationTime2048MS = 4
  • industrial_counter_bricklet.FrequencyIntegrationTime4096MS = 5
  • industrial_counter_bricklet.FrequencyIntegrationTime8192MS = 6
  • industrial_counter_bricklet.FrequencyIntegrationTime16384MS = 7
  • industrial_counter_bricklet.FrequencyIntegrationTime32768MS = 8
func (*IndustrialCounterBricklet) GetCounterConfiguration(channel uint8) (countEdge uint8, countDirection uint8, dutyCyclePrescaler uint8, frequencyIntegrationTime uint8, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • countEdge – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • countDirection – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • dutyCyclePrescaler – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • frequencyIntegrationTime – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

Gibt die Zähler-Konfiguration zurück, wie Sie mittels SetCounterConfiguration() gesetzt wurde.

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

Für channel:

  • industrial_counter_bricklet.Channel0 = 0
  • industrial_counter_bricklet.Channel1 = 1
  • industrial_counter_bricklet.Channel2 = 2
  • industrial_counter_bricklet.Channel3 = 3

Für countEdge:

  • industrial_counter_bricklet.CountEdgeRising = 0
  • industrial_counter_bricklet.CountEdgeFalling = 1
  • industrial_counter_bricklet.CountEdgeBoth = 2

Für countDirection:

  • industrial_counter_bricklet.CountDirectionUp = 0
  • industrial_counter_bricklet.CountDirectionDown = 1
  • industrial_counter_bricklet.CountDirectionExternalUp = 2
  • industrial_counter_bricklet.CountDirectionExternalDown = 3

Für dutyCyclePrescaler:

  • industrial_counter_bricklet.DutyCyclePrescaler1 = 0
  • industrial_counter_bricklet.DutyCyclePrescaler2 = 1
  • industrial_counter_bricklet.DutyCyclePrescaler4 = 2
  • industrial_counter_bricklet.DutyCyclePrescaler8 = 3
  • industrial_counter_bricklet.DutyCyclePrescaler16 = 4
  • industrial_counter_bricklet.DutyCyclePrescaler32 = 5
  • industrial_counter_bricklet.DutyCyclePrescaler64 = 6
  • industrial_counter_bricklet.DutyCyclePrescaler128 = 7
  • industrial_counter_bricklet.DutyCyclePrescaler256 = 8
  • industrial_counter_bricklet.DutyCyclePrescaler512 = 9
  • industrial_counter_bricklet.DutyCyclePrescaler1024 = 10
  • industrial_counter_bricklet.DutyCyclePrescaler2048 = 11
  • industrial_counter_bricklet.DutyCyclePrescaler4096 = 12
  • industrial_counter_bricklet.DutyCyclePrescaler8192 = 13
  • industrial_counter_bricklet.DutyCyclePrescaler16384 = 14
  • industrial_counter_bricklet.DutyCyclePrescaler32768 = 15

Für frequencyIntegrationTime:

  • industrial_counter_bricklet.FrequencyIntegrationTime128MS = 0
  • industrial_counter_bricklet.FrequencyIntegrationTime256MS = 1
  • industrial_counter_bricklet.FrequencyIntegrationTime512MS = 2
  • industrial_counter_bricklet.FrequencyIntegrationTime1024MS = 3
  • industrial_counter_bricklet.FrequencyIntegrationTime2048MS = 4
  • industrial_counter_bricklet.FrequencyIntegrationTime4096MS = 5
  • industrial_counter_bricklet.FrequencyIntegrationTime8192MS = 6
  • industrial_counter_bricklet.FrequencyIntegrationTime16384MS = 7
  • industrial_counter_bricklet.FrequencyIntegrationTime32768MS = 8
func (*IndustrialCounterBricklet) SetChannelLEDConfig(channel uint8, config uint8) (err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
Rückgabe:
  • err – Typ: error

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

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

Für channel:

  • industrial_counter_bricklet.Channel0 = 0
  • industrial_counter_bricklet.Channel1 = 1
  • industrial_counter_bricklet.Channel2 = 2
  • industrial_counter_bricklet.Channel3 = 3

Für config:

  • industrial_counter_bricklet.ChannelLEDConfigOff = 0
  • industrial_counter_bricklet.ChannelLEDConfigOn = 1
  • industrial_counter_bricklet.ChannelLEDConfigShowHeartbeat = 2
  • industrial_counter_bricklet.ChannelLEDConfigShowChannelStatus = 3
func (*IndustrialCounterBricklet) GetChannelLEDConfig(channel uint8) (config uint8, err error)
Parameter:
  • channel – Typ: uint8, Wertebereich: Siehe Konstanten
Rückgabe:
  • config – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 3
  • err – Typ: error

Gibt die Kanal-LED-Konfiguration zurück, wie von SetChannelLEDConfig() gesetzt.

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

Für channel:

  • industrial_counter_bricklet.Channel0 = 0
  • industrial_counter_bricklet.Channel1 = 1
  • industrial_counter_bricklet.Channel2 = 2
  • industrial_counter_bricklet.Channel3 = 3

Für config:

  • industrial_counter_bricklet.ChannelLEDConfigOff = 0
  • industrial_counter_bricklet.ChannelLEDConfigOn = 1
  • industrial_counter_bricklet.ChannelLEDConfigShowHeartbeat = 2
  • industrial_counter_bricklet.ChannelLEDConfigShowChannelStatus = 3

Fortgeschrittene Funktionen

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

  • industrial_counter_bricklet.StatusLEDConfigOff = 0
  • industrial_counter_bricklet.StatusLEDConfigOn = 1
  • industrial_counter_bricklet.StatusLEDConfigShowHeartbeat = 2
  • industrial_counter_bricklet.StatusLEDConfigShowStatus = 3
func (*IndustrialCounterBricklet) 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:

  • industrial_counter_bricklet.StatusLEDConfigOff = 0
  • industrial_counter_bricklet.StatusLEDConfigOn = 1
  • industrial_counter_bricklet.StatusLEDConfigShowHeartbeat = 2
  • industrial_counter_bricklet.StatusLEDConfigShowStatus = 3
func (*IndustrialCounterBricklet) 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 (*IndustrialCounterBricklet) 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 (*IndustrialCounterBricklet) 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', '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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein Bricklet hinter einem Isolator Bricklet ist immer an Position 'z'.

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

Konfigurationsfunktionen für Callbacks

func (*IndustrialCounterBricklet) SetAllCounterCallbackConfiguration(period uint32, valueHasToChange bool) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
Rückgabe:
  • err – Typ: error

Die Periode ist die Periode mit der der AllCounterCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

func (*IndustrialCounterBricklet) GetAllCounterCallbackConfiguration() (period uint32, valueHasToChange bool, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetAllCounterCallbackConfiguration() gesetzt.

func (*IndustrialCounterBricklet) SetAllSignalDataCallbackConfiguration(period uint32, valueHasToChange bool) (err error)
Parameter:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
Rückgabe:
  • err – Typ: error

Die Periode ist die Periode mit der der AllSignalDataCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

func (*IndustrialCounterBricklet) GetAllSignalDataCallbackConfiguration() (period uint32, valueHasToChange bool, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false
  • err – Typ: error

Gibt die Callback-Konfiguration zurück, wie mittels SetAllSignalDataCallbackConfiguration() gesetzt.

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 (*IndustrialCounterBricklet) RegisterAllCounterCallback(func(counter [4]int64)) (registrationId uint64)
Callback-Parameter:
  • counter – Typ: [4]int64, Wertebereich: [-247 bis 247 - 1]
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetAllCounterCallbackConfiguration() gesetzten Konfiguration

Die Parameter des Callbacks sind der gleiche wie GetAllCounter().

func (*IndustrialCounterBricklet) RegisterAllSignalDataCallback(func(dutyCycle [4]uint16, period [4]uint64, frequency [4]uint32, value [4]bool)) (registrationId uint64)
Callback-Parameter:
  • dutyCycle – Typ: [4]uint16, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: [4]uint64, Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: [4]uint32, Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: [4]bool
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetAllSignalDataCallbackConfiguration() gesetzten Konfiguration

Die Parameter des Callbacks sind der gleiche wie GetAllSignalData().

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

  • industrial_counter_bricklet.FunctionSetCounter = 3
  • industrial_counter_bricklet.FunctionSetAllCounter = 4
  • industrial_counter_bricklet.FunctionSetCounterActive = 7
  • industrial_counter_bricklet.FunctionSetAllCounterActive = 8
  • industrial_counter_bricklet.FunctionSetCounterConfiguration = 11
  • industrial_counter_bricklet.FunctionSetAllCounterCallbackConfiguration = 13
  • industrial_counter_bricklet.FunctionSetAllSignalDataCallbackConfiguration = 15
  • industrial_counter_bricklet.FunctionSetChannelLEDConfig = 17
  • industrial_counter_bricklet.FunctionSetWriteFirmwarePointer = 237
  • industrial_counter_bricklet.FunctionSetStatusLEDConfig = 239
  • industrial_counter_bricklet.FunctionReset = 243
  • industrial_counter_bricklet.FunctionWriteUID = 248
func (*IndustrialCounterBricklet) 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:

  • industrial_counter_bricklet.FunctionSetCounter = 3
  • industrial_counter_bricklet.FunctionSetAllCounter = 4
  • industrial_counter_bricklet.FunctionSetCounterActive = 7
  • industrial_counter_bricklet.FunctionSetAllCounterActive = 8
  • industrial_counter_bricklet.FunctionSetCounterConfiguration = 11
  • industrial_counter_bricklet.FunctionSetAllCounterCallbackConfiguration = 13
  • industrial_counter_bricklet.FunctionSetAllSignalDataCallbackConfiguration = 15
  • industrial_counter_bricklet.FunctionSetChannelLEDConfig = 17
  • industrial_counter_bricklet.FunctionSetWriteFirmwarePointer = 237
  • industrial_counter_bricklet.FunctionSetStatusLEDConfig = 239
  • industrial_counter_bricklet.FunctionReset = 243
  • industrial_counter_bricklet.FunctionWriteUID = 248
func (*IndustrialCounterBricklet) 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.

Interne Funktionen

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

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

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

Für status:

  • industrial_counter_bricklet.BootloaderStatusOK = 0
  • industrial_counter_bricklet.BootloaderStatusInvalidMode = 1
  • industrial_counter_bricklet.BootloaderStatusNoChange = 2
  • industrial_counter_bricklet.BootloaderStatusEntryFunctionNotPresent = 3
  • industrial_counter_bricklet.BootloaderStatusDeviceIdentifierIncorrect = 4
  • industrial_counter_bricklet.BootloaderStatusCRCMismatch = 5
func (*IndustrialCounterBricklet) 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:

  • industrial_counter_bricklet.BootloaderModeBootloader = 0
  • industrial_counter_bricklet.BootloaderModeFirmware = 1
  • industrial_counter_bricklet.BootloaderModeBootloaderWaitForReboot = 2
  • industrial_counter_bricklet.BootloaderModeFirmwareWaitForReboot = 3
  • industrial_counter_bricklet.BootloaderModeFirmwareWaitForEraseAndReboot = 4
func (*IndustrialCounterBricklet) 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 (*IndustrialCounterBricklet) 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 (*IndustrialCounterBricklet) 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 (*IndustrialCounterBricklet) 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.

Konstanten

industrial_counter_bricklet.DeviceIdentifier

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

industrial_counter_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Industrial Counter Bricklet dar.