Go - Piezo Buzzer Bricklet¶

Beep¶

Download (example_beep.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

package main

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

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

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

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

    // Make 2 second beep
    pb.Beep(2000)

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

Morse Code¶

Download (example_morse_code.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

package main

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

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

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

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

    // Morse SOS
    pb.MorseCode("... --- ...")

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

Grundfunktionen¶

func piezo_buzzer_bricklet.New(uid string, ipcon *IPConnection) (device PiezoBuzzerBricklet, err error)¶

Parameter:	uid – Typ: string ipcon – Typ: *IPConnection
Rückgabe:	device – Typ: PiezoBuzzerBricklet err – Typ: error

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

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

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

func (*PiezoBuzzerBricklet) Beep(duration uint32) (err error)¶

Parameter:	duration – Typ: uint32, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Rückgabe:	err – Typ: error

Erzeugt einen Piepton für die angegebene Dauer.

func (*PiezoBuzzerBricklet) MorseCode(morse string) (err error)¶

Parameter:	morse – Typ: string, Länge: bis zu 60
Rückgabe:	err – Typ: error

Setzt Morsecode welcher vom Piezosummer abgespielt wird. Der Morsecode wird als Zeichenkette, mit den Zeichen "." (Punkt), "-" (Minus) und " " (Leerzeichen) für kurzes Signale, langes Signale und Pausen. Alle anderen Zeichen werden ignoriert.

Beispiel: Wenn die Zeichenkette "...---..." gesetzt wird, gibt der Piezosummer neun Pieptöne aus mit den Dauern "kurz kurz kurz lang lang lang kurz kurz kurz".

Fortgeschrittene Funktionen¶

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

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.

func (*PiezoBuzzerBricklet) RegisterBeepFinishedCallback(func()) (registrationId uint64)¶

Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn ein Piepton, wie von Beep() gesetzt, beendet wurde.

func (*PiezoBuzzerBricklet) RegisterMorseCodeFinishedCallback(func()) (registrationId uint64)¶

Rückgabe:	registrationId – Typ: uint64

Dieser Callback wird ausgelöst, wenn die Wiedergabe des Morsecodes, wie von MorseCode() gesetzt, beendet wurde.

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

• piezo_buzzer_bricklet.FunctionBeep = 1
• piezo_buzzer_bricklet.FunctionMorseCode = 2

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

• piezo_buzzer_bricklet.FunctionBeep = 1
• piezo_buzzer_bricklet.FunctionMorseCode = 2

func (*PiezoBuzzerBricklet) 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¶

piezo_buzzer_bricklet.DeviceIdentifier¶

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

piezo_buzzer_bricklet.DeviceDisplayName¶

Diese Konstante stellt den Anzeigenamen eines Piezo Buzzer Bricklet dar.