C/C++ - Piezo Speaker Bricklet 2.0

Dies ist die Beschreibung der C/C++ API Bindings für das Piezo Speaker Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Piezo Speaker Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C/C++ API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Alarm

Download (example_alarm.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_v2.h"

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

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

    // Create device object
    PiezoSpeakerV2 ps;
    piezo_speaker_v2_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

    // 10 seconds of loud annoying fast alarm
    piezo_speaker_v2_set_alarm(&ps, 800, 2000, 10, 1, 10, 10000);

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

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_v2.h"

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

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

    // Create device object
    PiezoSpeakerV2 ps;
    piezo_speaker_v2_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_v2_set_beep(&ps, 1000, 0, 2000);

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

API

Jede Funktion der C/C++ Bindings gibt einen Integer zurück, welcher einen Fehlercode beschreibt. Vom Gerät zurückgegebene Daten werden, wenn eine Abfrage aufgerufen wurde, über Ausgabeparameter gehandhabt. Diese Parameter sind mit dem ret_ Präfix gekennzeichnet.

Mögliche Fehlercodes sind:

  • E_OK = 0
  • E_TIMEOUT = -1
  • E_NO_STREAM_SOCKET = -2
  • E_HOSTNAME_INVALID = -3
  • E_NO_CONNECT = -4
  • E_NO_THREAD = -5
  • E_NOT_ADDED = -6 (wird seit C/C++ Bindings Version 2.0.0 nicht mehr verwendet)
  • E_ALREADY_CONNECTED = -7
  • E_NOT_CONNECTED = -8
  • E_INVALID_PARAMETER = -9
  • E_NOT_SUPPORTED = -10
  • E_UNKNOWN_ERROR_CODE = -11
  • E_STREAM_OUT_OF_SYNC = -12
  • E_INVALID_UID = -13
  • E_NON_ASCII_CHAR_IN_SECRET = -14

wie in ip_connection.h definiert.

Alle folgend aufgelisteten Funktionen sind Thread-sicher.

Grundfunktionen

void piezo_speaker_v2_create(PiezoSpeakerV2 *piezo_speaker_v2, const char *uid, IPConnection *ipcon)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • uid – Typ: const char *
  • ipcon – Typ: IPConnection *

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

PiezoSpeakerV2 piezo_speaker_v2;
piezo_speaker_v2_create(&piezo_speaker_v2, "YOUR_DEVICE_UID", &ipcon);

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

void piezo_speaker_v2_destroy(PiezoSpeakerV2 *piezo_speaker_v2)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *

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

int piezo_speaker_v2_set_beep(PiezoSpeakerV2 *piezo_speaker_v2, uint16_t frequency, uint8_t volume, uint32_t duration)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • frequency – Typ: uint16_t, Einheit: 1 Hz, Wertebereich: [50 bis 15000]
  • volume – Typ: uint8_t, Wertebereich: [0 bis 10]
  • duration – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 232 - 1 bis] mit Konstanten
Rückgabe:
  • error_code – Typ: int

Erzeugt einen Piepton mit der gegebenen Frequenz und Lautstärke für die angegebene Dauer.

Eine duration von 0 stoppt den aktuellen Piepton. Eine duration von 4294967295 führt zu einem unendlich langen Piepton.

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

Für duration:

  • PIEZO_SPEAKER_V2_BEEP_DURATION_OFF = 0
  • PIEZO_SPEAKER_V2_BEEP_DURATION_INFINITE = 4294967295
int piezo_speaker_v2_get_beep(PiezoSpeakerV2 *piezo_speaker_v2, uint16_t *ret_frequency, uint8_t *ret_volume, uint32_t *ret_duration, uint32_t *ret_duration_remaining)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
Ausgabeparameter:
  • ret_frequency – Typ: uint16_t, Einheit: 1 Hz, Wertebereich: [50 bis 15000]
  • ret_volume – Typ: uint8_t, Wertebereich: [0 bis 10]
  • ret_duration – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 232 - 1 bis] mit Konstanten
  • ret_duration_remaining – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die letzten Beep-Einstellungen zurück, wie von piezo_speaker_v2_set_beep() gesetzt. Wenn ein Beep aktuell läuft, wird auch die verbleibende Zeit des Beeps zurück gegeben.

Wenn die Frequenz oder Lautstärke während eines Beeps aktualisiert wird (mit piezo_speaker_v2_update_frequency() oder piezo_speaker_v2_update_volume()), gibt diese Funktion die aktualisierten Werte zurück.

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

Für ret_duration:

  • PIEZO_SPEAKER_V2_BEEP_DURATION_OFF = 0
  • PIEZO_SPEAKER_V2_BEEP_DURATION_INFINITE = 4294967295
int piezo_speaker_v2_set_alarm(PiezoSpeakerV2 *piezo_speaker_v2, uint16_t start_frequency, uint16_t end_frequency, uint16_t step_size, uint16_t step_delay, uint8_t volume, uint32_t duration)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • start_frequency – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • end_frequency – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • step_size – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • step_delay – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • volume – Typ: uint8_t, Wertebereich: [0 bis 255]
  • duration – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 232 - 1 bis] mit Konstanten
Rückgabe:
  • error_code – Typ: int

Startet einen Alarm (Einen Ton der zwischen zwei spezifizierten Frequenzen hin und her läuft).

Die folgenden Parameter können genutzt werden:

  • Start Frequency: Startfrequenz des Alarms in Hz.
  • End Frequency: Endfrequenz des Alarms in Hz.
  • Step Size: Schrittgröße eines Schritts im Frequenzdurchlauf zwischen Start-/Endfrequenz in Hz.
  • Step Delay: Zeit zwischen zwei Schritten (Dauer eines Tons im Frequenzdurchlauf) in ms.
  • Duration: Dauer des Alarm in ms

Nachfolgend gibt es zwei Beispiele zum ausprobieren. Diese Beispiele können als Startpunkt genutzt werden um ein Alarm-Signal passend für die eigene Anwendung zu entwerfen.

Beispiel 1: 10 Sekunden eines lauten nervigen schnellen Alarms

  • Start Frequency = 800
  • End Frequency = 2000
  • Step Size = 10
  • Step Delay = 1
  • Volume = 10
  • Duration = 10000

Beispiel 2: 10 Sekunden eines Sirenengeräusches mit langsamen Frequenzdurchlauf

  • Start Frequency = 250
  • End Frequency = 750
  • Step Size = 1
  • Step Delay = 5
  • Volume = 0
  • Duration = 10000

Die Wertebereiche sind:

  • Start Frequency: 50Hz - 14999Hz (muss kleiner als End Frequency sein)
  • End Frequency: 51Hz - 15000Hz (muss größer als Start Frequency sein)
  • Step Size: 1Hz - 65535Hz (muss klein genug sein um in den Frequenzbereich zu passen)
  • Step Delay: 1ms - 65535ms (muss kleiner als Duration sein)
  • Volume: 0 - 10
  • Duration: 0ms - 4294967295ms

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

Für duration:

  • PIEZO_SPEAKER_V2_ALARM_DURATION_OFF = 0
  • PIEZO_SPEAKER_V2_ALARM_DURATION_INFINITE = 4294967295
int piezo_speaker_v2_get_alarm(PiezoSpeakerV2 *piezo_speaker_v2, uint16_t *ret_start_frequency, uint16_t *ret_end_frequency, uint16_t *ret_step_size, uint16_t *ret_step_delay, uint8_t *ret_volume, uint32_t *ret_duration, uint32_t *ret_duration_remaining, uint16_t *ret_current_frequency)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
Ausgabeparameter:
  • ret_start_frequency – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • ret_end_frequency – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • ret_step_size – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • ret_step_delay – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
  • ret_volume – Typ: uint8_t, Wertebereich: [0 bis 255]
  • ret_duration – Typ: uint32_t, Einheit: 1 ms, Wertebereich: [0 232 - 1 bis] mit Konstanten
  • ret_duration_remaining – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_current_frequency – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die letzten Alarm-Einstellungen zurück, wie von piezo_speaker_v2_set_alarm() gesetzt. Wenn ein Alarm aktuell läuft, wird auch die verbleibende Zeit des Alarms in ms sowie die aktuelle Frequenz in Hz zurück gegeben.

Wenn die Lautstärke während eines Alarms aktualisiert wird (mit piezo_speaker_v2_update_volume()), gibt diese Funktion die aktualisierten Werte zurück.

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

Für ret_duration:

  • PIEZO_SPEAKER_V2_ALARM_DURATION_OFF = 0
  • PIEZO_SPEAKER_V2_ALARM_DURATION_INFINITE = 4294967295
int piezo_speaker_v2_update_volume(PiezoSpeakerV2 *piezo_speaker_v2, uint8_t volume)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • volume – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Aktualisiert die Lautstärke eines aktuell laufenden Beep oder Alarm. Der Wertebereich der Lautstärke ist 0 bis 10.

int piezo_speaker_v2_update_frequency(PiezoSpeakerV2 *piezo_speaker_v2, uint16_t frequency)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • frequency – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_code – Typ: int

Aktualisiert die Frequenz eines aktuell laufenden Beeps. Der Wertebereich der Frequenz ist 50Hz bis 15000Hz.

Fortgeschrittene Funktionen

int piezo_speaker_v2_get_api_version(PiezoSpeakerV2 *piezo_speaker_v2, uint8_t ret_api_version[3])
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
Ausgabeparameter:
  • ret_api_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Gibt die Version der API Definition (Major, Minor, Revision) 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_v2_get_response_expected(PiezoSpeakerV2 *piezo_speaker_v2, uint8_t function_id, bool *ret_response_expected)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_response_expected – Typ: bool
Rückgabe:
  • error_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_v2_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_V2_FUNCTION_SET_BEEP = 1
  • PIEZO_SPEAKER_V2_FUNCTION_SET_ALARM = 3
  • PIEZO_SPEAKER_V2_FUNCTION_UPDATE_VOLUME = 5
  • PIEZO_SPEAKER_V2_FUNCTION_UPDATE_FREQUENCY = 6
  • PIEZO_SPEAKER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • PIEZO_SPEAKER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • PIEZO_SPEAKER_V2_FUNCTION_RESET = 243
  • PIEZO_SPEAKER_V2_FUNCTION_WRITE_UID = 248
int piezo_speaker_v2_set_response_expected(PiezoSpeakerV2 *piezo_speaker_v2, uint8_t function_id, bool response_expected)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • function_id – Typ: uint8_t, Wertebereich: Siehe Konstanten
  • response_expected – Typ: bool
Rückgabe:
  • error_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_V2_FUNCTION_SET_BEEP = 1
  • PIEZO_SPEAKER_V2_FUNCTION_SET_ALARM = 3
  • PIEZO_SPEAKER_V2_FUNCTION_UPDATE_VOLUME = 5
  • PIEZO_SPEAKER_V2_FUNCTION_UPDATE_FREQUENCY = 6
  • PIEZO_SPEAKER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • PIEZO_SPEAKER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • PIEZO_SPEAKER_V2_FUNCTION_RESET = 243
  • PIEZO_SPEAKER_V2_FUNCTION_WRITE_UID = 248
int piezo_speaker_v2_set_response_expected_all(PiezoSpeakerV2 *piezo_speaker_v2, bool response_expected)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • response_expected – Typ: bool
Rückgabe:
  • error_code – Typ: int

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

int piezo_speaker_v2_get_spitfp_error_count(PiezoSpeakerV2 *piezo_speaker_v2, uint32_t *ret_error_count_ack_checksum, uint32_t *ret_error_count_message_checksum, uint32_t *ret_error_count_frame, uint32_t *ret_error_count_overflow)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
Ausgabeparameter:
  • ret_error_count_ack_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_message_checksum – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_frame – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
  • ret_error_count_overflow – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int piezo_speaker_v2_set_bootloader_mode(PiezoSpeakerV2 *piezo_speaker_v2, uint8_t mode, uint8_t *ret_status)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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 Bootlodaer- 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:

  • PIEZO_SPEAKER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • PIEZO_SPEAKER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für ret_status:

  • PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_OK = 0
  • PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • PIEZO_SPEAKER_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
int piezo_speaker_v2_get_bootloader_mode(PiezoSpeakerV2 *piezo_speaker_v2, uint8_t *ret_mode)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
Ausgabeparameter:
  • ret_mode – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_mode:

  • PIEZO_SPEAKER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • PIEZO_SPEAKER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • PIEZO_SPEAKER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
int piezo_speaker_v2_set_write_firmware_pointer(PiezoSpeakerV2 *piezo_speaker_v2, uint32_t pointer)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • pointer – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Setzt den Firmware-Pointer für piezo_speaker_v2_write_firmware(). 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.

int piezo_speaker_v2_write_firmware(PiezoSpeakerV2 *piezo_speaker_v2, uint8_t data[64], uint8_t *ret_status)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • data – Typ: uint8_t[64], Wertebereich: [0 bis 255]
Ausgabeparameter:
  • ret_status – Typ: uint8_t, Wertebereich: [0 bis 255]
Rückgabe:
  • error_code – Typ: int

Schreibt 64 Bytes Firmware an die Position die vorher von piezo_speaker_v2_set_write_firmware_pointer() 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.

int piezo_speaker_v2_set_status_led_config(PiezoSpeakerV2 *piezo_speaker_v2, uint8_t config)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • config – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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:

  • PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_OFF = 0
  • PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_ON = 1
  • PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int piezo_speaker_v2_get_status_led_config(PiezoSpeakerV2 *piezo_speaker_v2, uint8_t *ret_config)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
Ausgabeparameter:
  • ret_config – Typ: uint8_t, Wertebereich: Siehe Konstanten
Rückgabe:
  • error_code – Typ: int

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

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

Für ret_config:

  • PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_OFF = 0
  • PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_ON = 1
  • PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • PIEZO_SPEAKER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
int piezo_speaker_v2_get_chip_temperature(PiezoSpeakerV2 *piezo_speaker_v2, int16_t *ret_temperature)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
Ausgabeparameter:
  • ret_temperature – Typ: int16_t, Wertebereich: [-215 bis 215 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die Temperatur in °C, 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.

int piezo_speaker_v2_reset(PiezoSpeakerV2 *piezo_speaker_v2)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
Rückgabe:
  • error_code – Typ: int

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.

int piezo_speaker_v2_write_uid(PiezoSpeakerV2 *piezo_speaker_v2, uint32_t uid)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

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.

int piezo_speaker_v2_read_uid(PiezoSpeakerV2 *piezo_speaker_v2, uint32_t *ret_uid)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
Ausgabeparameter:
  • ret_uid – Typ: uint32_t, Wertebereich: [0 bis 232 - 1]
Rückgabe:
  • error_code – Typ: int

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

int piezo_speaker_v2_get_identity(PiezoSpeakerV2 *piezo_speaker_v2, 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_v2 – Typ: PiezoSpeakerV2 *
Ausgabeparameter:
  • ret_uid – Typ: char[8]
  • ret_connected_uid – Typ: char[8]
  • ret_position – Typ: char
  • ret_hardware_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
  • ret_firmware_version – Typ: uint8_t[3], Wertebereich: [0 bis 255]
  • ret_device_identifier – Typ: uint16_t, Wertebereich: [0 bis 216 - 1]
Rückgabe:
  • error_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 kann 'a', 'b', 'c' oder 'd' sein.

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_v2_register_callback(PiezoSpeakerV2 *piezo_speaker_v2, int16_t callback_id, void (*function)(void), void *user_data)
Parameter:
  • piezo_speaker_v2 – Typ: PiezoSpeakerV2 *
  • 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_v2_register_callback() Funktion durchgeführt werden:

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

piezo_speaker_v2_register_callback(&piezo_speaker_v2, PIEZO_SPEAKER_V2_CALLBACK_EXAMPLE, (void (*)(void))my_callback, NULL);

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

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.

PIEZO_SPEAKER_V2_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_v2_set_beep() gesetzt, beendet wurde.

PIEZO_SPEAKER_V2_CALLBACK_ALARM_FINISHED
void callback(void *user_data)
Callback-Parameter:
  • user_data – Typ: void *

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

Konstanten

PIEZO_SPEAKER_V2_DEVICE_IDENTIFIER

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

Die piezo_speaker_v2_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_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Piezo Speaker Bricklet 2.0 dar.