Go - Hall Effect Bricklet

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

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
package main

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

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

func main() {
    ipcon := ipconnection.New()
    defer ipcon.Close()
    he, _ := hall_effect_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 edge count without reset.
    count, _ := he.GetEdgeCount(false)
    fmt.Printf("Count: \n", count)

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

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
package main

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

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

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

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

    he.RegisterEdgeCountCallback(func(count uint32, value bool) {
        fmt.Printf("Count: %d\n", count)
    })

    // Set period for edge count receiver to 0.05s (50ms).
    // Note: The edge count callback is only called every 0.05 seconds
    //       if the edge count has changed since the last call!
    he.SetEdgeCountCallbackPeriod(50)

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

API

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

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

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

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

func (*HallEffectBricklet) GetValue() (value bool, err error)
Rückgabe:
  • value – Typ: bool
  • err – Typ: error

Gibt true zurück wenn ein Magnetfeld mit 3,5 Millitesla oder größer detektiert wird.

func (*HallEffectBricklet) GetEdgeCount(resetCounter bool) (count uint32, err error)
Parameter:
  • resetCounter – Typ: bool
Rückgabe:
  • count – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • err – Typ: error

Gibt den aktuellen Wert des Flankenzählers zurück. Die zu zählenden Flanken (steigend, fallend, beide) können mit SetEdgeCountConfig() konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

Fortgeschrittene Funktionen

func (*HallEffectBricklet) SetEdgeCountConfig(edgeType uint8, debounce uint8) (err error)
Parameter:
  • edgeType – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • debounce – Typ: uint8, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100
Rückgabe:
  • err – Typ: error

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

  • 0 = steigend
  • 1 = fallend
  • 2 = beide

Wird ein Magnet in die Nähe des Bricklets gebracht (>3,5 Millitesla) erzeugt dies ein low-Signal (fallende Flanke), wenn ein Magnet vom Bricklet entfernt (<2,5 Millitesla) wird entsteht ein high-Signal (steigende Flanke).

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

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

Für edgeType:

  • hall_effect_bricklet.EdgeTypeRising = 0
  • hall_effect_bricklet.EdgeTypeFalling = 1
  • hall_effect_bricklet.EdgeTypeBoth = 2
func (*HallEffectBricklet) GetEdgeCountConfig() (edgeType uint8, debounce uint8, err error)
Rückgabe:
  • edgeType – Typ: uint8, Wertebereich: Siehe Konstanten, Standardwert: 0
  • debounce – Typ: uint8, Einheit: 1 ms, Wertebereich: [0 bis 255], Standardwert: 100
  • err – Typ: error

Gibt den Flankentyp sowie die Entprellzeit zurück, wie von SetEdgeCountConfig() gesetzt.

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

Für edgeType:

  • hall_effect_bricklet.EdgeTypeRising = 0
  • hall_effect_bricklet.EdgeTypeFalling = 1
  • hall_effect_bricklet.EdgeTypeBoth = 2
func (*HallEffectBricklet) 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 (*HallEffectBricklet) SetEdgeInterrupt(edges uint32) (err error)
Parameter:
  • edges – Typ: uint32, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Rückgabe:
  • err – Typ: error

Setzt die Anzahl der zu zählenden Flanken bis ein Interrupt aufgerufen wird.

Wenn edges auf n gesetzt ist, wird der Interrupt nach jeder n-ten detektierten Flanke aufgerufen.

Wenn edges auf 0 gesetzt ist, wird der Interrupt deaktiviert.

func (*HallEffectBricklet) GetEdgeInterrupt() (edges uint32, err error)
Rückgabe:
  • edges – Typ: uint32, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

Gibt edges zurück, wie von SetEdgeInterrupt() gesetzt.

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

Setzt die Periode mit welcher der RegisterEdgeCountCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der RegisterEdgeCountCallback Callback wird nur ausgelöst, wenn sich die Flankenzählung seit der letzten Auslösung geändert hat.

func (*HallEffectBricklet) GetEdgeCountCallbackPeriod() (period uint32, err error)
Rückgabe:
  • period – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • err – Typ: error

Gibt die Periode zurück, wie von SetEdgeCountCallbackPeriod() 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 (*HallEffectBricklet) RegisterEdgeCountCallback(func(count uint32, value bool)) (registrationId uint64)
Callback-Parameter:
  • count – Typ: uint32, Wertebereich: [0 bis 232 - 1]
  • value – Typ: bool
Rückgabe:
  • registrationId – Typ: uint64

Dieser Callback wird mit der Periode, wie gesetzt mit SetEdgeCountCallbackPeriod(), ausgelöst. Die Parameter des Callbacks sind der aktuelle Zählerstand und der aktuelle Wert (siehe GetValue() and GetEdgeCount()).

Der RegisterEdgeCountCallback Callback wird nur ausgelöst, wenn sich mindestens einer der beiden Werte seit der letzten Auslösung geändert hat.

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

  • hall_effect_bricklet.FunctionSetEdgeCountConfig = 3
  • hall_effect_bricklet.FunctionSetEdgeInterrupt = 5
  • hall_effect_bricklet.FunctionSetEdgeCountCallbackPeriod = 7
func (*HallEffectBricklet) 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:

  • hall_effect_bricklet.FunctionSetEdgeCountConfig = 3
  • hall_effect_bricklet.FunctionSetEdgeInterrupt = 5
  • hall_effect_bricklet.FunctionSetEdgeCountCallbackPeriod = 7
func (*HallEffectBricklet) 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

hall_effect_bricklet.DeviceIdentifier

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

hall_effect_bricklet.DeviceDisplayName

Diese Konstante stellt den Anzeigenamen eines Hall Effect Bricklet dar.