C/C++ - Piezo Speaker Bricklet¶

Beep¶

Download (example_beep.c)

 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

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_piezo_speaker.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Piezo Speaker Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    PiezoSpeaker ps;
    piezo_speaker_create(&ps, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Make 2 second beep with a frequency of 1kHz
    piezo_speaker_beep(&ps, 2000, 1000);

    printf("Press key to exit\n");
    getchar();
    piezo_speaker_destroy(&ps);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Morse Code¶

Download (example_morse_code.c)

 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

#include <stdio.h>

#include "ip_connection.h"
#include "bricklet_piezo_speaker.h"

#define HOST "localhost"
#define PORT 4223
#define UID "XYZ" // Change XYZ to the UID of your Piezo Speaker Bricklet

int main(void) {
    // Create IP connection
    IPConnection ipcon;
    ipcon_create(&ipcon);

    // Create device object
    PiezoSpeaker ps;
    piezo_speaker_create(&ps, UID, &ipcon);

    // Connect to brickd
    if(ipcon_connect(&ipcon, HOST, PORT) < 0) {
        fprintf(stderr, "Could not connect\n");
        return 1;
    }
    // Don't use device before ipcon is connected

    // Morse SOS with a frequency of 2kHz
    piezo_speaker_morse_code(&ps, "... --- ...", 2000);

    printf("Press key to exit\n");
    getchar();
    piezo_speaker_destroy(&ps);
    ipcon_destroy(&ipcon); // Calls ipcon_disconnect internally
    return 0;
}

Grundfunktionen¶

void piezo_speaker_create(PiezoSpeaker *piezo_speaker, const char *uid, IPConnection *ipcon)¶

Parameter:	piezo_speaker – Typ: PiezoSpeaker * uid – Typ: const char * ipcon – Typ: IPConnection *

Erzeugt ein Geräteobjekt piezo_speaker mit der eindeutigen Geräte ID uid und fügt es der IP Connection ipcon hinzu:

PiezoSpeaker piezo_speaker;
piezo_speaker_create(&piezo_speaker, "YOUR_DEVICE_UID", &ipcon);

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

void piezo_speaker_destroy(PiezoSpeaker *piezo_speaker)¶

Parameter:	piezo_speaker – Typ: PiezoSpeaker *

Entfernt das Geräteobjekt piezo_speaker von dessen IP Connection und zerstört es. Das Geräteobjekt kann hiernach nicht mehr verwendet werden.

int piezo_speaker_beep(PiezoSpeaker *piezo_speaker, uint32_t duration, uint16_t frequency)¶

Parameter:	piezo_speaker – Typ: PiezoSpeaker * duration – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] mit Konstanten frequency – Typ: uint16_t, Einheit: 1 Hz, Wertebereich: [585 bis 7100]
Rückgabe:	e_code – Typ: int

Erzeugt einen Piepton mit der gegebenen Frequenz für die angegebene Dauer.

Geändert in Version 2.0.2 (Plugin): Eine durarion von 0 stoppt den aktuellen Piepton, der frequency Parameter wird ignoriert. Eine durarion von 4294967295 führt zu einem unendlich langen Piepton.

Das Piezo Speaker Bricklet kann die angegebenen Frequenzen nur approximieren, es wählt die bestmögliche Zuordnung anhand der Kalibrierung (siehe piezo_speaker_calibrate()).

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

Für duration:

• PIEZO_SPEAKER_BEEP_DURATION_OFF = 0
• PIEZO_SPEAKER_BEEP_DURATION_INFINITE = 4294967295

int piezo_speaker_morse_code(PiezoSpeaker *piezo_speaker, const char *morse, uint16_t frequency)¶

Parameter:	piezo_speaker – Typ: PiezoSpeaker * morse – Typ: const char[60] frequency – Typ: uint16_t, Einheit: 1 Hz, Wertebereich: [585 bis 7100]
Rückgabe:	e_code – Typ: int

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¶

int piezo_speaker_calibrate(PiezoSpeaker *piezo_speaker, bool *ret_calibration)¶

Parameter:	piezo_speaker – Typ: PiezoSpeaker *
Ausgabeparameter:	ret_calibration – Typ: bool
Rückgabe:	e_code – Typ: int

Das Piezo Speaker Bricklet kann 512 unterschiedliche Töne spielen. Diese Funktion spielt jeden Ton einmal und misst die exakte Frequenz zurück. Das Ergebnis ist eine Zuordnung von Stellwerten zu Frequenzen. Diese Zuordnung wird im EEPROM gespeichert und bei jedem start des Bricklets geladen.

Das Bricklet sollte bei Auslieferung bereits kalibriert sein. Diese Funktion muss lediglich (einmalig) nach jedem neuflashen des Bricklet-Plugins ausgeführt werden.

Gibt true nach Abschluss der Kalibrierung zurück.

int piezo_speaker_get_identity(PiezoSpeaker *piezo_speaker, char ret_uid[8], char ret_connected_uid[8], char *ret_position, uint8_t ret_hardware_version[3], uint8_t ret_firmware_version[3], uint16_t *ret_device_identifier)¶

Parameter:	piezo_speaker – Typ: PiezoSpeaker *
Ausgabeparameter:	ret_uid – Typ: char[8] ret_connected_uid – Typ: char[8] ret_position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] ret_hardware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_firmware_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255] ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:	e_code – Typ: int

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¶

void piezo_speaker_register_callback(PiezoSpeaker *piezo_speaker, int16_t callback_id, void (*function)(void), void *user_data)¶

Parameter:	piezo_speaker – Typ: PiezoSpeaker * callback_id – Typ: int16_t function – Typ: void (*)(void) user_data – Typ: void *

Registriert die function für die gegebene callback_id. Die user_data werden der Funktion als letztes Parameter mit übergeben.

Die verfügbaren Callback IDs mit den zugehörigen Funktionssignaturen sind unten zu finden.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit der piezo_speaker_register_callback() Funktion durchgeführt werden:

void my_callback(int value, void *user_data) {
    printf("Value: %d\n", value);
}

piezo_speaker_register_callback(&piezo_speaker,
                                PIEZO_SPEAKER_CALLBACK_EXAMPLE,
                                (void (*)(void))my_callback,
                                NULL);

Die verfügbaren Konstanten mit den zugehörigen Funktionssignaturen werden weiter unten beschrieben.

PIEZO_SPEAKER_CALLBACK_BEEP_FINISHED¶

void callback(void *user_data)

Callback-Parameter:	user_data – Typ: void *

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

PIEZO_SPEAKER_CALLBACK_MORSE_CODE_FINISHED¶

void callback(void *user_data)

Callback-Parameter:	user_data – Typ: void *

Dieser Callback wird ausgelöst, wenn die Wiedergabe des Morsecodes, wie von piezo_speaker_morse_code() 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.

int piezo_speaker_get_api_version(PiezoSpeaker *piezo_speaker, uint8_t ret_api_version[3])¶

Parameter:	piezo_speaker – Typ: PiezoSpeaker *
Ausgabeparameter:	ret_api_version – Typ: uint8_t[3] 0: major – Typ: uint8_t, Wertebereich: [0 bis 255] 1: minor – Typ: uint8_t, Wertebereich: [0 bis 255] 2: revision – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:	e_code – Typ: int

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.

int piezo_speaker_get_response_expected(PiezoSpeaker *piezo_speaker, uint8_t function_id, bool *ret_response_expected)¶

Parameter:	piezo_speaker – Typ: PiezoSpeaker * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:	ret_response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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 piezo_speaker_set_response_expected(). 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 function_id:

• PIEZO_SPEAKER_FUNCTION_BEEP = 1
• PIEZO_SPEAKER_FUNCTION_MORSE_CODE = 2

int piezo_speaker_set_response_expected(PiezoSpeaker *piezo_speaker, uint8_t function_id, bool response_expected)¶

Parameter:	piezo_speaker – Typ: PiezoSpeaker * function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

Ä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 function_id:

• PIEZO_SPEAKER_FUNCTION_BEEP = 1
• PIEZO_SPEAKER_FUNCTION_MORSE_CODE = 2

int piezo_speaker_set_response_expected_all(PiezoSpeaker *piezo_speaker, bool response_expected)¶

Parameter:	piezo_speaker – Typ: PiezoSpeaker * response_expected – Typ: bool
Rückgabe:	e_code – Typ: int

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

Konstanten¶

PIEZO_SPEAKER_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Piezo Speaker Bricklet zu identifizieren.

Die piezo_speaker_get_identity() Funktion und der IPCON_CALLBACK_ENUMERATE Callback der IP Connection haben ein device_identifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

PIEZO_SPEAKER_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Piezo Speaker Bricklet dar.