MQTT - Current12 Bricklet¶

Simple¶

Download (example-simple.txt)

1
2
3
4
5
6

# Change XYZ to the UID of your Current12 Bricklet

setup:
    # Get current current
    subscribe to tinkerforge/response/current12_bricklet/XYZ/get_current
    publish '' to tinkerforge/request/current12_bricklet/XYZ/get_current

Callback¶

Download (example-callback.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

# Change XYZ to the UID of your Current12 Bricklet

setup:
    # Handle incoming current callbacks
    subscribe to tinkerforge/callback/current12_bricklet/XYZ/current
    publish '{"register": true}' to tinkerforge/register/current12_bricklet/XYZ/current # Register current callback

    # Set period for current callback to 1s (1000ms)
    # Note: The current callback is only called every second
    #       if the current has changed since the last call!
    publish '{"period": 1000}' to tinkerforge/request/current12_bricklet/XYZ/set_current_callback_period

Threshold¶

Download (example-threshold.txt)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

# Change XYZ to the UID of your Current12 Bricklet

setup:
    # Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    publish '{"debounce": 10000}' to tinkerforge/request/current12_bricklet/XYZ/set_debounce_period

    # Handle incoming current reached callbacks
    subscribe to tinkerforge/callback/current12_bricklet/XYZ/current_reached
    publish '{"register": true}' to tinkerforge/register/current12_bricklet/XYZ/current_reached # Register current_reached callback

    # Configure threshold for current "greater than 5 A"
    publish '{"option": "greater", "min": 5000, "max": 0}' to tinkerforge/request/current12_bricklet/XYZ/set_current_callback_threshold

Grundfunktionen¶

request/current12_bricklet/<UID>/get_current¶

Anfrage:	keine Nutzdaten
Antwort:	current – Typ: int, Einheit: 1 mA, Wertebereich: [-12500 bis 12500]

Gibt die gemessenen Stromstärke des Sensors zurück.

Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen den register/current12_bricklet/<UID>/current Callback zu nutzen und die Periode mit request/current12_bricklet/<UID>/set_current_callback_period vorzugeben.

Fortgeschrittene Funktionen¶

request/current12_bricklet/<UID>/calibrate¶

Anfrage:	keine Nutzdaten
Antwort:	keine Antwort

Kalibriert den Nullwert des Sensors. Diese Funktion muss aufgerufen werden, wenn kein Strom fließt.

Der Nullwert des Stromsensors ist abhängig von den exakten Eigenschaften des Analog-Digital-Wandlers, der Länge des Bricklet Kabels und der Temperatur. Daher ist es, bei Wechsel des Brick oder bei Veränderung der Umgebung in welcher das Bricklet genutzt wird, ratsam erneut zu kalibrieren.

Die resultierende Kalibrierung wird in den EEPROM des Current Bricklet gespeichert.

request/current12_bricklet/<UID>/is_over_current¶

Anfrage:	keine Nutzdaten
Antwort:	over – Typ: bool

Gibt true zurück wenn mehr als 12,5A gemessen wurden.

Bemerkung

Um diesen Wert zurückzusetzen ist ein Aus- und Wiedereinschalten des Bricklet notwendig.

request/current12_bricklet/<UID>/get_analog_value¶

Anfrage:	keine Nutzdaten
Antwort:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.

Bemerkung

Der von request/current12_bricklet/<UID>/get_current zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während request/current12_bricklet/<UID>/get_analog_value unverarbeitete Analogwerte zurück gibt. Der einzige Grund request/current12_bricklet/<UID>/get_analog_value zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den register/current12_bricklet/<UID>/analog_value Callback zu nutzen und die Periode mit request/current12_bricklet/<UID>/set_analog_value_callback_period vorzugeben.

request/current12_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", "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 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. 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 Current12.

Konfigurationsfunktionen für Callbacks¶

request/current12_bricklet/<UID>/set_current_callback_period¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/current12_bricklet/<UID>/current Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/current12_bricklet/<UID>/current Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

request/current12_bricklet/<UID>/get_current_callback_period¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/current12_bricklet/<UID>/set_current_callback_period gesetzt.

request/current12_bricklet/<UID>/set_analog_value_callback_period¶

Anfrage:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt die Periode mit welcher der register/current12_bricklet/<UID>/analog_value Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der register/current12_bricklet/<UID>/analog_value Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

request/current12_bricklet/<UID>/get_analog_value_callback_period¶

Anfrage:	keine Nutzdaten
Antwort:	period – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von request/current12_bricklet/<UID>/set_analog_value_callback_period gesetzt.

request/current12_bricklet/<UID>/set_current_callback_threshold¶

Anfrage:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den register/current12_bricklet/<UID>/current_reached Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Stromstärke außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Stromstärke innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Stromstärke kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Stromstärke größer als der min Wert ist (max wird ignoriert)

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

Für option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/current12_bricklet/<UID>/get_current_callback_threshold¶

Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mA, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/current12_bricklet/<UID>/set_current_callback_threshold gesetzt.

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

Für option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/current12_bricklet/<UID>/set_analog_value_callback_threshold¶

Anfrage:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0
Antwort:	keine Antwort

Setzt den Schwellwert für den register/current12_bricklet/<UID>/analog_value_reached Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn der Analogwert außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn der Analogwert innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn der Analogwert kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn der Analogwert größer als der min Wert ist (max wird ignoriert)

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

Für option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/current12_bricklet/<UID>/get_analog_value_callback_threshold¶

Anfrage:	keine Nutzdaten
Antwort:	option – Typ: char, Wertebereich: Siehe Symbole, Standardwert: "x" min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von request/current12_bricklet/<UID>/set_analog_value_callback_threshold gesetzt.

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

Für option:

• "off" = "x"
• "outside" = "o"
• "inside" = "i"
• "smaller" = "<"
• "greater" = ">"

request/current12_bricklet/<UID>/set_debounce_period¶

Anfrage:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100
Antwort:	keine Antwort

Setzt die Periode mit welcher die Schwellwert Callbacks

• register/current12_bricklet/<UID>/current_reached,
• register/current12_bricklet/<UID>/analog_value_reached

ausgelöst werden, wenn die Schwellwerte

• request/current12_bricklet/<UID>/set_current_callback_threshold,
• request/current12_bricklet/<UID>/set_analog_value_callback_threshold

weiterhin erreicht bleiben.

request/current12_bricklet/<UID>/get_debounce_period¶

Anfrage:	keine Nutzdaten
Antwort:	debounce – Typ: int, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von request/current12_bricklet/<UID>/set_debounce_period gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung kann mit dem entsprechenden .../register/...-Topic und einem optionalen Suffix durchgeführt werden. Mit diesem Suffix kann das Callback später deregistriert werden.

register/current12_bricklet/<UID>/current¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	current – Typ: int, Einheit: 1 mA, Wertebereich: [-12500 bis 12500]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/current12_bricklet/<UID>/current[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/current12_bricklet/<UID>/current[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/current12_bricklet/<UID>/set_current_callback_period, ausgelöst. Der Payload des Callbacks ist die Stromstärke des Sensors.

Der register/current12_bricklet/<UID>/current Callback wird nur ausgelöst, wenn sich die Stromstärke seit der letzten Auslösung geändert hat.

register/current12_bricklet/<UID>/analog_value¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/current12_bricklet/<UID>/analog_value[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/current12_bricklet/<UID>/analog_value[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird mit der Periode, wie gesetzt mit request/current12_bricklet/<UID>/set_analog_value_callback_period, ausgelöst. Der Payload des Callbacks ist der Analogwert des Umgebungslichtsensors.

Der register/current12_bricklet/<UID>/analog_value Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

register/current12_bricklet/<UID>/current_reached¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	current – Typ: int, Einheit: 1 mA, Wertebereich: [-12500 bis 12500]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/current12_bricklet/<UID>/current_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/current12_bricklet/<UID>/current_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/current12_bricklet/<UID>/set_current_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist die Stromstärke des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/current12_bricklet/<UID>/set_debounce_period gesetzt, ausgelöst.

register/current12_bricklet/<UID>/analog_value_reached¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/current12_bricklet/<UID>/analog_value_reached[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/current12_bricklet/<UID>/analog_value_reached[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von request/current12_bricklet/<UID>/set_analog_value_callback_threshold gesetzt, erreicht wird. Der Payload des Callbacks ist der Analogwert des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit request/current12_bricklet/<UID>/set_debounce_period gesetzt, ausgelöst.

register/current12_bricklet/<UID>/over_current¶

Registrierungsanfrage:	register – Typ: bool
Callback-Antwort:	keine Nutzdaten

Ein Callback für dieses Event kann durch Senden des Payloads "true" an das .../register/current12_bricklet/<UID>/over_current[/<SUFFIX>]-Topic hinzugefügt werden. Ein hinzugefügtes Callback kann durch Senden des Payloads "false" an das selbe Topic wieder entfernt werden. Um mehrere (De-)Registrierungen zu unterstützen, z.B. um Nachrichten filtern zu können, kann ein optionaler Suffix verwendet werden.

Wenn das Callback ausgelöst wird, wird dessen Payload für jeden Suffix auf dem entsprechenden .../callback/current12_bricklet/<UID>/over_current[/<SUFFIX>]-Topic veröffentlicht.

Dieser Callback wird ausgelöst, wenn ein Überstrom gemessen wurde (siehe request/current12_bricklet/<UID>/is_over_current).