Dies ist die Beschreibung des Modbus Protokolls für das Current25 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Current25 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.
Eine allgemeine Beschreibung der Modbus Protokollstruktur findet sich hier.
BrickletCurrent25.
get_current
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die gemessene Stromstärke des Sensors zurück.
Wenn die Stromstärke periodisch abgefragt werden soll, wird empfohlen
den CALLBACK_CURRENT
Callback zu nutzen und die Periode mit
set_current_callback_period
vorzugeben.
BrickletCurrent25.
calibrate
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
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.
BrickletCurrent25.
is_over_current
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt true zurück wenn mehr als 25A gemessen wurden.
Bemerkung
Um diesen Wert zurückzusetzen ist ein Aus- und Wiedereinschalten des Bricklet notwendig.
BrickletCurrent25.
get_analog_value
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Wert, wie vom 12-Bit Analog-Digital-Wandler gelesen, zurück.
Bemerkung
Der von get_current
zurückgegebene Wert ist über mehrere
Messwerte gemittelt um das Rauschen zu vermindern, während get_analog_value
unverarbeitete Analogwerte zurück gibt. Der einzige Grund 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 CALLBACK_ANALOG_VALUE
Callback zu nutzen und die Periode mit
set_analog_value_callback_period
vorzugeben.
BrickletCurrent25.
get_identity
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
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.
BrickletCurrent25.
set_current_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher der CALLBACK_CURRENT
Callback ausgelöst wird.
Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_CURRENT
Callback wird nur ausgelöst, wenn sich die Stromstärke seit
der letzten Auslösung geändert hat.
BrickletCurrent25.
get_current_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Periode zurück, wie von set_current_callback_period
gesetzt.
BrickletCurrent25.
set_analog_value_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher der CALLBACK_ANALOG_VALUE
Callback ausgelöst
wird. Ein Wert von 0 deaktiviert den Callback.
Der CALLBACK_ANALOG_VALUE
Callback wird nur ausgelöst, wenn sich der Analogwert
seit der letzten Auslösung geändert hat.
BrickletCurrent25.
get_analog_value_callback_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Periode zurück, wie von set_analog_value_callback_period
gesetzt.
BrickletCurrent25.
set_current_callback_threshold
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt den Schwellwert für den CALLBACK_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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletCurrent25.
get_current_callback_threshold
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Schwellwert zurück, wie von set_current_callback_threshold
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletCurrent25.
set_analog_value_callback_threshold
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt den Schwellwert für den CALLBACK_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 Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletCurrent25.
get_analog_value_callback_threshold
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt den Schwellwert zurück, wie von set_analog_value_callback_threshold
gesetzt.
Die folgenden Bedeutungen sind für die Elemente dieser Funktion definiert:
Für option:
BrickletCurrent25.
set_debounce_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Setzt die Periode mit welcher die Schwellwert Callbacks
ausgelöst werden, wenn die Schwellwerte
weiterhin erreicht bleiben.
BrickletCurrent25.
get_debounce_period
¶Funktions-ID: |
|
---|---|
Anfrage: |
|
Antwort: |
|
Gibt die Entprellperiode zurück, wie von set_debounce_period
gesetzt.
BrickletCurrent25.
CALLBACK_CURRENT
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit set_current_callback_period
,
ausgelöst. Der Rückgabewert ist die Stromstärke des Sensors.
Der CALLBACK_CURRENT
Callback wird nur ausgelöst, wenn sich die Stromstärke seit der
letzten Auslösung geändert hat.
BrickletCurrent25.
CALLBACK_ANALOG_VALUE
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird mit der Periode, wie gesetzt mit set_analog_value_callback_period
,
ausgelöst. Der Rückgabewert ist der Analogwert des Sensors.
Der CALLBACK_ANALOG_VALUE
Callback wird nur ausgelöst, wenn sich der Analogwert seit der
letzten Auslösung geändert hat.
BrickletCurrent25.
CALLBACK_CURRENT_REACHED
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
set_current_callback_threshold
gesetzt, erreicht wird.
Der Rückgabewert ist die Stromstärke des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit set_debounce_period
gesetzt, ausgelöst.
BrickletCurrent25.
CALLBACK_ANALOG_VALUE_REACHED
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von
set_analog_value_callback_threshold
gesetzt, erreicht wird.
Der Rückgabewert ist der Analogwert des Sensors.
Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie
mit set_debounce_period
gesetzt, ausgelöst.
BrickletCurrent25.
CALLBACK_OVER_CURRENT
¶Funktions-ID: |
|
---|---|
Antwort: |
|
Dieser Callback wird ausgelöst, wenn ein Überstrom gemessen wurde
(siehe is_over_current
).