MATLAB/Octave - Analog In Bricklet¶

Simple (MATLAB)¶

Download (matlab_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletAnalogIn;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Analog In Bricklet

    ipcon = IPConnection(); % Create IP connection
    ai = handle(BrickletAnalogIn(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current voltage
    voltage = ai.getVoltage();
    fprintf('Voltage: %g V\n', voltage/1000.0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

Callback (MATLAB)¶

Download (matlab_example_callback.m)

 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

function matlab_example_callback()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletAnalogIn;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Analog In Bricklet

    ipcon = IPConnection(); % Create IP connection
    ai = handle(BrickletAnalogIn(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register voltage callback to function cb_voltage
    set(ai, 'VoltageCallback', @(h, e) cb_voltage(e));

    % Set period for voltage callback to 1s (1000ms)
    % Note: The voltage callback is only called every second
    %       if the voltage has changed since the last call!
    ai.setVoltageCallbackPeriod(1000);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for voltage callback
function cb_voltage(e)
    fprintf('Voltage: %g V\n', e.voltage/1000.0);
end

Threshold (MATLAB)¶

Download (matlab_example_threshold.m)

 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

function matlab_example_threshold()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletAnalogIn;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Analog In Bricklet

    ipcon = IPConnection(); % Create IP connection
    ai = handle(BrickletAnalogIn(UID, ipcon), 'CallbackProperties'); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    ai.setDebouncePeriod(10000);

    % Register voltage reached callback to function cb_voltage_reached
    set(ai, 'VoltageReachedCallback', @(h, e) cb_voltage_reached(e));

    % Configure threshold for voltage "smaller than 5 V"
    ai.setVoltageCallbackThreshold('<', 5*1000, 0);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
end

% Callback function for voltage reached callback
function cb_voltage_reached(e)
    fprintf('Voltage: %g V\n', e.voltage/1000.0);
end

Simple (Octave)¶

Download (octave_example_simple.m)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Analog In Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    ai = javaObject("com.tinkerforge.BrickletAnalogIn", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get current voltage
    voltage = ai.getVoltage();
    fprintf("Voltage: %g V\n", voltage/1000.0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

Callback (Octave)¶

Download (octave_example_callback.m)

 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

function octave_example_callback()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Analog In Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    ai = javaObject("com.tinkerforge.BrickletAnalogIn", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Register voltage callback to function cb_voltage
    ai.addVoltageCallback(@cb_voltage);

    % Set period for voltage callback to 1s (1000ms)
    % Note: The voltage callback is only called every second
    %       if the voltage has changed since the last call!
    ai.setVoltageCallbackPeriod(1000);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for voltage callback
function cb_voltage(e)
    fprintf("Voltage: %g V\n", e.voltage/1000.0);
end

Threshold (Octave)¶

Download (octave_example_threshold.m)

 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

function octave_example_threshold()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Analog In Bricklet

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection
    ai = javaObject("com.tinkerforge.BrickletAnalogIn", UID, ipcon); % Create device object

    ipcon.connect(HOST, PORT); % Connect to brickd
    % Don't use device before ipcon is connected

    % Get threshold callbacks with a debounce time of 10 seconds (10000ms)
    ai.setDebouncePeriod(10000);

    % Register voltage reached callback to function cb_voltage_reached
    ai.addVoltageReachedCallback(@cb_voltage_reached);

    % Configure threshold for voltage "smaller than 5 V"
    ai.setVoltageCallbackThreshold("<", 5*1000, 0);

    input("Press key to exit\n", "s");
    ipcon.disconnect();
end

% Callback function for voltage reached callback
function cb_voltage_reached(e)
    fprintf("Voltage: %g V\n", e.voltage/1000.0);
end

Grundfunktionen¶

class BrickletAnalogIn(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	analogIn – Typ: BrickletAnalogIn

Erzeugt ein Objekt mit der eindeutigen Geräte ID uid.

In MATLAB:

import com.tinkerforge.BrickletAnalogIn;

analogIn = BrickletAnalogIn("YOUR_DEVICE_UID", ipcon);

In Octave:

analogIn = java_new("com.tinkerforge.BrickletAnalogIn", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

int BrickletAnalogIn.getVoltage()¶

Rückgabe:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 45000]

Gibt die gemessene Spannung des Sensors zurück. Die Auflösung im Bereich 0 bis 6V beträgt rund 2mV. Zwischen 6 und 45V ist die Auflösung rund 10mV.

Wenn die Spannung periodisch abgefragt werden soll, wird empfohlen den VoltageCallback Callback zu nutzen und die Periode mit setVoltageCallbackPeriod() vorzugeben.

void BrickletAnalogIn.setRange(short range)¶

Parameter:	range – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den Messbereich. Mögliche Bereiche:

• 0: Automatisch geschaltet
• 1: 0V - 6,05V, ~1,48mV Auflösung
• 2: 0V - 10,32V, ~2,52mV Auflösung
• 3: 0V - 36,30V, ~8,86mV Auflösung
• 4: 0V - 45,00V, ~11,25mV Auflösung
• 5: 0V - 3,3V, ~0,81mV Auflösung, neu in Version 2.0.3 (Plugin)

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

Für range:

• BrickletAnalogIn.RANGE_AUTOMATIC = 0
• BrickletAnalogIn.RANGE_UP_TO_6V = 1
• BrickletAnalogIn.RANGE_UP_TO_10V = 2
• BrickletAnalogIn.RANGE_UP_TO_36V = 3
• BrickletAnalogIn.RANGE_UP_TO_45V = 4
• BrickletAnalogIn.RANGE_UP_TO_3V = 5

Neu in Version 2.0.1 (Plugin).

short BrickletAnalogIn.getRange()¶

Rückgabe:	range – Typ: short, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den Messbereich zurück, wie von setRange() gesetzt.

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

Für range:

• BrickletAnalogIn.RANGE_AUTOMATIC = 0
• BrickletAnalogIn.RANGE_UP_TO_6V = 1
• BrickletAnalogIn.RANGE_UP_TO_10V = 2
• BrickletAnalogIn.RANGE_UP_TO_36V = 3
• BrickletAnalogIn.RANGE_UP_TO_45V = 4
• BrickletAnalogIn.RANGE_UP_TO_3V = 5

Neu in Version 2.0.1 (Plugin).

Fortgeschrittene Funktionen¶

int BrickletAnalogIn.getAnalogValue()¶

Rückgabe:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

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

Bemerkung

Der von getVoltage() zurückgegebene Wert ist über mehrere Messwerte gemittelt um das Rauschen zu vermindern, während getAnalogValue() unverarbeitete Analogwerte zurück gibt. Der einzige Grund getAnalogValue() zu nutzen, ist die volle Auflösung des Analog-Digital-Wandlers zu erhalten.

Wenn der Analogwert periodisch abgefragt werden soll, wird empfohlen den AnalogValueCallback Callback zu nutzen und die Periode mit setAnalogValueCallbackPeriod() vorzugeben.

void BrickletAnalogIn.setAveraging(short average)¶

Parameter:	average – Typ: short, Wertebereich: [0 bis 255], Standardwert: 50

Setzt die Länge des Mittelwerts für die Spannung.

Wenn die Länge auf 0 gesetzt wird, ist das Averaging komplett aus. In diesem Fall gibt es mehr Rauschen auf den Daten, allerdings sind die Daten dann ohne Verzögerung.

Neu in Version 2.0.3 (Plugin).

short BrickletAnalogIn.getAveraging()¶

Rückgabe:	average – Typ: short, Wertebereich: [0 bis 255], Standardwert: 50

Gibt die Averaging-Konfiguration zurück, wie von setAveraging() gesetzt.

Neu in Version 2.0.3 (Plugin).

BrickletAnalogIn.Identity BrickletAnalogIn.getIdentity()¶

Rückgabeobjekt:

uid – Typ: String, Länge: bis zu 8 connectedUid – Typ: String, Länge: bis zu 8 position – Typ: char, Wertebereich: ['a' bis 'h', 'z'] hardwareVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255] firmwareVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255] deviceIdentifier – Typ: int, Wertebereich: [0 bis 216 - 1]

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. Es gibt auch eine Konstante für den Device Identifier dieses Bricklets.

Konfigurationsfunktionen für Callbacks¶

void BrickletAnalogIn.setVoltageCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der VoltageCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der VoltageCallback Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

long BrickletAnalogIn.getVoltageCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setVoltageCallbackPeriod() gesetzt.

void BrickletAnalogIn.setAnalogValueCallbackPeriod(long period)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der AnalogValueCallback Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der AnalogValueCallback Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

long BrickletAnalogIn.getAnalogValueCallbackPeriod()¶

Rückgabe:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von setAnalogValueCallbackPeriod() gesetzt.

void BrickletAnalogIn.setVoltageCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den VoltageReachedCallback Callback.

Die folgenden Optionen sind möglich:

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

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

Für option:

• BrickletAnalogIn.THRESHOLD_OPTION_OFF = 'x'
• BrickletAnalogIn.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletAnalogIn.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletAnalogIn.THRESHOLD_OPTION_SMALLER = '<'
• BrickletAnalogIn.THRESHOLD_OPTION_GREATER = '>'

BrickletAnalogIn.VoltageCallbackThreshold BrickletAnalogIn.getVoltageCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von setVoltageCallbackThreshold() gesetzt.

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

Für option:

• BrickletAnalogIn.THRESHOLD_OPTION_OFF = 'x'
• BrickletAnalogIn.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletAnalogIn.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletAnalogIn.THRESHOLD_OPTION_SMALLER = '<'
• BrickletAnalogIn.THRESHOLD_OPTION_GREATER = '>'

void BrickletAnalogIn.setAnalogValueCallbackThreshold(char option, int min, int max)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0 max – Typ: int, Wertebereich: [0 bis 216 - 1], Standardwert: 0

Setzt den Schwellwert für den AnalogValueReachedCallback 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 Konstanten sind für diese Funktion verfügbar:

Für option:

• BrickletAnalogIn.THRESHOLD_OPTION_OFF = 'x'
• BrickletAnalogIn.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletAnalogIn.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletAnalogIn.THRESHOLD_OPTION_SMALLER = '<'
• BrickletAnalogIn.THRESHOLD_OPTION_GREATER = '>'

BrickletAnalogIn.AnalogValueCallbackThreshold BrickletAnalogIn.getAnalogValueCallbackThreshold()¶

Rückgabeobjekt:	option – Typ: char, Wertebereich: Siehe Konstanten, 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 setAnalogValueCallbackThreshold() gesetzt.

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

Für option:

• BrickletAnalogIn.THRESHOLD_OPTION_OFF = 'x'
• BrickletAnalogIn.THRESHOLD_OPTION_OUTSIDE = 'o'
• BrickletAnalogIn.THRESHOLD_OPTION_INSIDE = 'i'
• BrickletAnalogIn.THRESHOLD_OPTION_SMALLER = '<'
• BrickletAnalogIn.THRESHOLD_OPTION_GREATER = '>'

void BrickletAnalogIn.setDebouncePeriod(long debounce)¶

Parameter:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callbacks

• VoltageReachedCallback,
• AnalogValueReachedCallback

ausgelöst werden, wenn die Schwellwerte

• setVoltageCallbackThreshold(),
• setAnalogValueCallbackThreshold()

weiterhin erreicht bleiben.

long BrickletAnalogIn.getDebouncePeriod()¶

Rückgabe:	debounce – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von setDebouncePeriod() gesetzt.

Callbacks¶

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung wird mit MATLABs "set" Funktion durchgeführt. Die Parameter sind ein Gerätobjekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

function my_callback(e)
    fprintf('Parameter: %s\n', e.param);
end

set(device, 'ExampleCallback', @(h, e) my_callback(e));

Die Octave Java Unterstützung unterscheidet sich hier von MATLAB, die "set" Funktion kann hier nicht verwendet werden. Die Registrierung wird in Octave mit "add*Callback" Funktionen des Gerätobjekts durchgeführt. Hier ein Beispiel in Octave:

function my_callback(e)
    fprintf("Parameter: %s\n", e.param);
end

device.addExampleCallback(@my_callback);

Es ist möglich mehrere Callback-Funktion hinzuzufügen und auch mit einem korrespondierenden "remove*Callback" wieder zu entfernen.

Die Parameter des Callbacks werden der Callback-Funktion als Felder der Struktur e übergeben. Diese ist von der java.util.EventObject Klasse abgeleitete. Die verfügbaren Callback-Namen mit den entsprechenden Strukturfeldern werden unterhalb beschrieben.

callback BrickletAnalogIn.VoltageCallback¶

Event-Objekt:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 45000]

Dieser Callback wird mit der Periode, wie gesetzt mit setVoltageCallbackPeriod(), ausgelöst. Der Parameter ist die gemessene Spannung des Sensors.

Der VoltageCallback Callback wird nur ausgelöst, wenn sich die Spannung seit der letzten Auslösung geändert hat.

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addVoltageCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeVoltageCallback() wieder entfernt werden.

callback BrickletAnalogIn.AnalogValueCallback¶

Event-Objekt:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird mit der Periode, wie gesetzt mit setAnalogValueCallbackPeriod(), ausgelöst. Der Parameter ist der Analogwert des Sensors.

Der AnalogValueCallback Callback wird nur ausgelöst, wenn sich der Analogwert seit der letzten Auslösung geändert hat.

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addAnalogValueCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeAnalogValueCallback() wieder entfernt werden.

callback BrickletAnalogIn.VoltageReachedCallback¶

Event-Objekt:	voltage – Typ: int, Einheit: 1 mV, Wertebereich: [0 bis 45000]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setVoltageCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist die gemessene Spannung des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addVoltageReachedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeVoltageReachedCallback() wieder entfernt werden.

callback BrickletAnalogIn.AnalogValueReachedCallback¶

Event-Objekt:	value – Typ: int, Wertebereich: [0 bis 212 - 1]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von setAnalogValueCallbackThreshold() gesetzt, erreicht wird. Der Parameter ist der Analogwert des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit setDebouncePeriod() gesetzt, ausgelöst.

In MATLAB kann die set() Function verwendet werden um diesem Callback eine Callback-Function zuzuweisen.

In Octave kann diesem Callback mit addAnalogValueReachedCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeAnalogValueReachedCallback() wieder entfernt werden.

Virtuelle Funktionen¶

Virtuelle Funktionen kommunizieren nicht mit dem Gerät selbst, sie arbeiten nur auf dem API Bindings Objekt. Dadurch können sie auch aufgerufen werden, ohne das das dazugehörige IP Connection Objekt verbunden ist.

short[] BrickletAnalogIn.getAPIVersion()¶

Rückgabeobjekt:	apiVersion – Typ: short[], Länge: 3 1: major – Typ: short, Wertebereich: [0 bis 255] 2: minor – Typ: short, Wertebereich: [0 bis 255] 3: revision – Typ: short, Wertebereich: [0 bis 255]

Gibt die Version der API Definition 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.

boolean BrickletAnalogIn.getResponseExpected(byte functionId)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:	responseExpected – Typ: boolean

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 setResponseExpected(). 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 functionId:

• BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
• BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
• BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletAnalogIn.FUNCTION_SET_DEBOUNCE_PERIOD = 11
• BrickletAnalogIn.FUNCTION_SET_RANGE = 17
• BrickletAnalogIn.FUNCTION_SET_AVERAGING = 19

void BrickletAnalogIn.setResponseExpected(byte functionId, boolean responseExpected)¶

Parameter:	functionId – Typ: byte, Wertebereich: Siehe Konstanten responseExpected – Typ: boolean

Ä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 functionId:

• BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_PERIOD = 3
• BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_PERIOD = 5
• BrickletAnalogIn.FUNCTION_SET_VOLTAGE_CALLBACK_THRESHOLD = 7
• BrickletAnalogIn.FUNCTION_SET_ANALOG_VALUE_CALLBACK_THRESHOLD = 9
• BrickletAnalogIn.FUNCTION_SET_DEBOUNCE_PERIOD = 11
• BrickletAnalogIn.FUNCTION_SET_RANGE = 17
• BrickletAnalogIn.FUNCTION_SET_AVERAGING = 19

void BrickletAnalogIn.setResponseExpectedAll(boolean responseExpected)¶

Parameter:	responseExpected – Typ: boolean

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

Konstanten¶

int BrickletAnalogIn.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Analog In Bricklet zu identifizieren.

Die getIdentity() Funktion und der IPConnection.EnumerateCallback Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

String BrickletAnalogIn.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Analog In Bricklet dar.