MQTT - Analog Out Bricklet

Dies ist die Beschreibung der MQTT API Bindings für das Analog Out Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Analog Out Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die MQTT API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (example-simple.txt)

1
2
3
4
5
# Change XYZ to the UID of your Analog Out Bricklet

setup:
    # Set output voltage to 3.3V
    publish '{"voltage": 3300}' to tinkerforge/request/analog_out_bricklet/XYZ/set_voltage 

API

Alle veröffentlichten Payloads an die und von den MQTT-Bindings sind im JSON Format.

Falls ein Fehler auftritt, veröffentlichen die Bindings ein JSON-Objekt, das die Fehlermeldung als _ERROR-Member enthält. Das Objekt wird auf dem zugehörigen Antwort-Topic veröffentlicht: .../response/... für .../request/... und .../callback/... für .../register/....

Grundfunktionen

request/analog_out_bricklet/<UID>/set_voltage
Anfrage:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 5000], Standardwert: 0
Antwort:
  • keine Antwort

Setzt die Spannung. Dieser Funktionsaufruf setzt den Modus auf 0 (siehe request/analog_out_bricklet/<UID>/set_mode).

request/analog_out_bricklet/<UID>/get_voltage
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 5000], Standardwert: 0

Gibt die Spannung zurück, wie von request/analog_out_bricklet/<UID>/set_voltage gesetzt.

request/analog_out_bricklet/<UID>/set_mode
Anfrage:
  • mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1
Antwort:
  • keine Antwort

Setzt den Modus des Analogwertes. Mögliche Modi:

Setzten des Modus auf 0 resultiert in einer Ausgabespannung von 0 V. Es kann über einen Aufruf von request/analog_out_bricklet/<UID>/set_voltage direkt auf eine höhere Ausgabespannung gewechselt werden .

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

Für mode:

  • "analog_value" = 0
  • "1k_to_ground" = 1
  • "100k_to_ground" = 2
  • "500k_to_ground" = 3
request/analog_out_bricklet/<UID>/get_mode
Anfrage:
  • keine Nutzdaten
Antwort:
  • mode – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1

Gibt den Modus zurück, wie von request/analog_out_bricklet/<UID>/set_mode gesetzt.

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

Für mode:

  • "analog_value" = 0
  • "1k_to_ground" = 1
  • "100k_to_ground" = 2
  • "500k_to_ground" = 3

Fortgeschrittene Funktionen

request/analog_out_bricklet/<UID>/get_identity
Anfrage:
  • keine Nutzdaten
Antwort:
  • uid – Typ: string, Länge: bis zu 8
  • connected_uid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ["a" bis "h", "i", "z"]
  • hardware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • firmware_version – Typ: [int, ...], Länge: 3
    • 0: major – Typ: int, Wertebereich: [0 bis 255]
    • 1: minor – Typ: int, Wertebereich: [0 bis 255]
    • 2: revision – Typ: int, Wertebereich: [0 bis 255]
  • device_identifier – Typ: int, Wertebereich: [0 bis 216 - 1]
  • _display_name – Typ: string

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. Falls die symbolische Ausgabe nicht deaktiviert wurde, wird der Device Identifier auf den entsprechenden Namen im Format, welches die Topics verwenden, abgebildet.

Der Display Name enthält den Anzeigenamen des Analog Out.