MQTT - Industrial Analog Out Bricklet

Dies ist die Beschreibung der MQTT API Bindings für das Industrial Analog Out Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial 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 Current

Download (example-simple-current.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your Industrial Analog Out Bricklet

setup:
    # Set output current to 4.5mA
    publish '{"current": 4500}' to tinkerforge/request/industrial_analog_out_bricklet/XYZ/set_current 
    
    publish '' to tinkerforge/request/industrial_analog_out_bricklet/XYZ/enable 

cleanup:
    # If you are done, run this to clean up
    publish '' to tinkerforge/request/industrial_analog_out_bricklet/XYZ/disable 

Simple Voltage

Download (example-simple-voltage.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# Change XYZ to the UID of your Industrial Analog Out Bricklet

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

cleanup:
    # If you are done, run this to clean up
    publish '' to tinkerforge/request/industrial_analog_out_bricklet/XYZ/disable 

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/industrial_analog_out_bricklet/<UID>/enable
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Aktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

request/industrial_analog_out_bricklet/<UID>/disable
Anfrage:
  • keine Nutzdaten
Antwort:
  • keine Antwort

Deaktiviert die Ausgabe von Spannung und Strom.

Der Standardwert ist deaktiviert.

request/industrial_analog_out_bricklet/<UID>/is_enabled
Anfrage:
  • keine Nutzdaten
Antwort:
  • enabled – Typ: bool, Standardwert: false

Gibt true zurück falls die Ausgabe von Spannung und Strom aktiviert ist, false sonst.

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

Setzt die Ausgangsspannung.

Die Ausgangsspannung und der Ausgangsstrom sind gekoppelt. Eine Änderung der Ausgangsspannung führt auch zu einer Änderung des Ausgangsstroms.

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

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

request/industrial_analog_out_bricklet/<UID>/set_current
Anfrage:
  • current – Typ: int, Einheit: 1 µA, Wertebereich: [0 bis 24000]
Antwort:
  • keine Antwort

Setzt den Ausgangsstrom.

Der Ausgangsstrom und die Ausgangsspannung sind gekoppelt. Eine Änderung des Ausgangsstroms führt auch zu einer Änderung der Ausgangsspannung.

request/industrial_analog_out_bricklet/<UID>/get_current
Anfrage:
  • keine Nutzdaten
Antwort:
  • current – Typ: int, Einheit: 1 µA, Wertebereich: [0 bis 24000]

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

Fortgeschrittene Funktionen

request/industrial_analog_out_bricklet/<UID>/set_configuration
Anfrage:
  • voltage_range – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1
  • current_range – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0
Antwort:
  • keine Antwort

Konfiguriert die Spannungs- und Stromwertebereiche.

Einstellbare Spannungswertebereiche sind:

  • 0V bis 5V
  • 0V bis 10V

Einstellbare Stromwertebereiche sind:

  • 4mA bis 20mA
  • 0mA bis 20mA
  • 0mA bis 24mA

Die Auflösung ist immer 12 Bit. Dass heißt, die Genauigkeit erhöht sich bei kleineren Wertebereichen.

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

Für voltage_range:

  • "0_to_5v" = 0
  • "0_to_10v" = 1

Für current_range:

  • "4_to_20ma" = 0
  • "0_to_20ma" = 1
  • "0_to_24ma" = 2
request/industrial_analog_out_bricklet/<UID>/get_configuration
Anfrage:
  • keine Nutzdaten
Antwort:
  • voltage_range – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 1
  • current_range – Typ: int, Wertebereich: Siehe Symbole, Standardwert: 0

Gibt die Konfiguration zurück, wie von request/industrial_analog_out_bricklet/<UID>/set_configuration gesetzt.

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

Für voltage_range:

  • "0_to_5v" = 0
  • "0_to_10v" = 1

Für current_range:

  • "4_to_20ma" = 0
  • "0_to_20ma" = 1
  • "0_to_24ma" = 2
request/industrial_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 Industrial Analog Out.