MATLAB/Octave - Compass 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.BrickletCompass;

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

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

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

    % Get current heading
    heading = c.getHeading();
    fprintf('Heading: %g °\n', heading/10.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

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

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

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

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

    % Register heading callback to function cb_heading
    set(c, 'HeadingCallback', @(h, e) cb_heading(e));

    % Set period for heading callback to 0.1s (100ms) without a threshold
    c.setHeadingCallbackConfiguration(100, false, 'x', 0, 0);

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

% Callback function for heading callback
function cb_heading(e)
    fprintf('Heading: %g °\n', e.heading/10.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 Compass Bricklet

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

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

    % Get current heading
    heading = c.getHeading();
    fprintf("Heading: %g °\n", heading/10.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

function octave_example_callback()
    more off;

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

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

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

    % Register heading callback to function cb_heading
    c.addHeadingCallback(@cb_heading);

    % Set period for heading callback to 0.1s (100ms) without a threshold
    c.setHeadingCallbackConfiguration(100, false, "x", 0, 0);

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

% Callback function for heading callback
function cb_heading(e)
    fprintf("Heading: %g °\n", e.heading/10.0);
end

Grundfunktionen¶

class BrickletCompass(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	compass – Typ: BrickletCompass

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

In MATLAB:

import com.tinkerforge.BrickletCompass;

compass = BrickletCompass("YOUR_DEVICE_UID", ipcon);

In Octave:

compass = java_new("com.tinkerforge.BrickletCompass", "YOUR_DEVICE_UID", ipcon);

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

int BrickletCompass.getHeading()¶

Rückgabe:	heading – Typ: int, Einheit: 1/10 °, Wertebereich: [0 bis 3600]

Gibt die Richtung zurück (Norden = 0 Grad, Osten = 90 Grad).

Alternativ kann die Funktion getMagneticFluxDensity() genutzt werden um die Richtung per heading = atan2(y, x) * 180 / PI zu bestimmen.

Wenn der Wert periodisch benötigt wird, kann auch der HeadingCallback Callback verwendet werden. Der Callback wird mit der Funktion setHeadingCallbackConfiguration() konfiguriert.

BrickletCompass.MagneticFluxDensity BrickletCompass.getMagneticFluxDensity()¶

Rückgabeobjekt:	x – Typ: int, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000] y – Typ: int, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000] z – Typ: int, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000]

Gibt die magnetische Flussdichte (magnetische Induktion) für alle drei Achsen zurück.

Wenn der Wert periodisch benötigt wird, kann auch der MagneticFluxDensityCallback Callback verwendet werden. Der Callback wird mit der Funktion setMagneticFluxDensityCallbackConfiguration() konfiguriert.

void BrickletCompass.setConfiguration(int dataRate, boolean backgroundCalibration)¶

Parameter:	dataRate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 backgroundCalibration – Typ: boolean, Standardwert: true

Konfiguriert die Datenrate und Hintergrundkalibrierung:

• Data Rate: Setzt die Datenrate des eingesetzten Magnetometers. Je niedriger die Datenrate ist, desto weniger Rauschen befindet sich auf den Daten.
• Background Calibration: Aktiviert die automatische Hintergrundkalibrierung, wenn auf true gesetzt. Wenn die Hintergrundkalibrierung aktiviert ist, ändert das Bricklet einmal pro Sekunde die Erfassungspolarität, um damit automatisch temperaturabhängige Offsets zu entfernen. Das Ändern der Polarität dauert ungefähr 20ms. Daher werden einmal pro Sekunde für 20ms keine neuen Daten generiert, wenn die Kalibrierung aktiviert ist. Wir empfehlen die Kalibrierung nur zu deaktivieren, falls diese 20ms Auszeit ein großes Problem in der Anwendung des Bricklets darstellen.

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

Für dataRate:

• BrickletCompass.DATA_RATE_100HZ = 0
• BrickletCompass.DATA_RATE_200HZ = 1
• BrickletCompass.DATA_RATE_400HZ = 2
• BrickletCompass.DATA_RATE_600HZ = 3

BrickletCompass.Configuration BrickletCompass.getConfiguration()¶

Rückgabeobjekt:	dataRate – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 0 backgroundCalibration – Typ: boolean, Standardwert: true

Gibt die Konfiguration zurück, wie von setConfiguration() gesetzt.

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

Für dataRate:

• BrickletCompass.DATA_RATE_100HZ = 0
• BrickletCompass.DATA_RATE_200HZ = 1
• BrickletCompass.DATA_RATE_400HZ = 2
• BrickletCompass.DATA_RATE_600HZ = 3

Fortgeschrittene Funktionen¶

void BrickletCompass.setCalibration(int[] offset, int[] gain)¶

Parameter:

offset – Typ: int[], Länge: 3 1: x – Typ: int, Einheit: 1/100 µT, Wertebereich: [-215 bis 215 - 1] 2: y – Typ: int, Einheit: 1/100 µT, Wertebereich: [-215 bis 215 - 1] 3: z – Typ: int, Einheit: 1/100 µT, Wertebereich: [-215 bis 215 - 1] gain – Typ: int[], Länge: 3 1: x – Typ: int, Wertebereich: [-215 bis 215 - 1] 2: y – Typ: int, Wertebereich: [-215 bis 215 - 1] 3: z – Typ: int, Wertebereich: [-215 bis 215 - 1]

Setzt Offset und Gain für alle drei Achsen.

Das Bricklet ist ab Werk kalibriert. Wenn eine Rekalibrierung durchgeführt werden soll, empfehlen wir dafür den Brick Viewer zu nutzen.

Die Kalibrierung wird in nicht-flüchtigem Speicher gespeichert und muss nur einmal durchgeführt werden.

BrickletCompass.Calibration BrickletCompass.getCalibration()¶

Rückgabeobjekt:

offset – Typ: int[], Länge: 3 1: x – Typ: int, Einheit: 1/100 µT, Wertebereich: [-215 bis 215 - 1] 2: y – Typ: int, Einheit: 1/100 µT, Wertebereich: [-215 bis 215 - 1] 3: z – Typ: int, Einheit: 1/100 µT, Wertebereich: [-215 bis 215 - 1] gain – Typ: int[], Länge: 3 1: x – Typ: int, Wertebereich: [-215 bis 215 - 1] 2: y – Typ: int, Wertebereich: [-215 bis 215 - 1] 3: z – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Kalibrierungsparameter zurück, wie von setCalibration() gesetzt.

BrickletCompass.SPITFPErrorCount BrickletCompass.getSPITFPErrorCount()¶

Rückgabeobjekt:	errorCountAckChecksum – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountMessageChecksum – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountFrame – Typ: long, Wertebereich: [0 bis 232 - 1] errorCountOverflow – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt die Anzahl der Fehler die während der Kommunikation zwischen Brick und Bricklet aufgetreten sind zurück.

Die Fehler sind aufgeteilt in

• ACK-Checksummen Fehler,
• Message-Checksummen Fehler,
• Framing Fehler und
• Overflow Fehler.

Die Fehlerzähler sind für Fehler die auf der Seite des Bricklets auftreten. Jedes Brick hat eine ähnliche Funktion welche die Fehler auf Brickseite ausgibt.

void BrickletCompass.setStatusLEDConfig(int config)¶

Parameter:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Setzt die Konfiguration der Status-LED. Standardmäßig zeigt die LED die Kommunikationsdatenmenge an. Sie blinkt einmal auf pro 10 empfangenen Datenpaketen zwischen Brick und Bricklet.

Die LED kann auch permanent an/aus gestellt werden oder einen Herzschlag anzeigen.

Wenn das Bricklet sich im Bootlodermodus befindet ist die LED aus.

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

Für config:

• BrickletCompass.STATUS_LED_CONFIG_OFF = 0
• BrickletCompass.STATUS_LED_CONFIG_ON = 1
• BrickletCompass.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletCompass.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletCompass.getStatusLEDConfig()¶

Rückgabe:	config – Typ: int, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von setStatusLEDConfig() gesetzt.

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

Für config:

• BrickletCompass.STATUS_LED_CONFIG_OFF = 0
• BrickletCompass.STATUS_LED_CONFIG_ON = 1
• BrickletCompass.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletCompass.STATUS_LED_CONFIG_SHOW_STATUS = 3

int BrickletCompass.getChipTemperature()¶

Rückgabe:	temperature – Typ: int, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, gemessen im Mikrocontroller, aus. Der Rückgabewert ist nicht die Umgebungstemperatur.

Die Temperatur ist lediglich proportional zur echten Temperatur und hat eine hohe Ungenauigkeit. Daher beschränkt sich der praktische Nutzen auf die Indikation von Temperaturveränderungen.

void BrickletCompass.reset()¶

Ein Aufruf dieser Funktion setzt das Bricklet zurück. Nach einem Neustart sind alle Konfiguration verloren.

Nach dem Zurücksetzen ist es notwendig neue Objekte zu erzeugen, Funktionsaufrufe auf bestehenden führen zu undefiniertem Verhalten.

BrickletCompass.Identity BrickletCompass.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 BrickletCompass.setHeadingCallbackConfiguration(long period, boolean valueHasToChange, char option, int min, int max)¶

Parameter:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/10 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Die Periode ist die Periode mit der der HeadingCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den HeadingCallback Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Threshold ist abgeschaltet
'o'	Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i'	Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<'	Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>'	Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

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

Für option:

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

BrickletCompass.HeadingCallbackConfiguration BrickletCompass.getHeadingCallbackConfiguration()¶

Rückgabeobjekt:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: int, Einheit: 1/10 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: int, Einheit: 1/10 °, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt die Callback-Konfiguration zurück, wie mittels setHeadingCallbackConfiguration() gesetzt.

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

Für option:

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

void BrickletCompass.setMagneticFluxDensityCallbackConfiguration(long period, boolean valueHasToChange)¶

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

Die Periode ist die Periode mit der der MagneticFluxDensityCallback Callback ausgelöst wird. Ein Wert von 0 schaltet den Callback ab.

Wenn der value has to change-Parameter auf True gesetzt wird, wird der Callback nur ausgelöst, wenn der Wert sich im Vergleich zum letzten mal geändert hat. Ändert der Wert sich nicht innerhalb der Periode, so wird der Callback sofort ausgelöst, wenn der Wert sich das nächste mal ändert.

Wird der Parameter auf False gesetzt, so wird der Callback dauerhaft mit der festen Periode ausgelöst unabhängig von den Änderungen des Werts.

BrickletCompass.MagneticFluxDensityCallbackConfiguration BrickletCompass.getMagneticFluxDensityCallbackConfiguration()¶

Rückgabeobjekt:	period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0 valueHasToChange – Typ: boolean, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels setMagneticFluxDensityCallbackConfiguration() 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 BrickletCompass.HeadingCallback¶

Event-Objekt:	heading – Typ: int, Einheit: 1/10 °, Wertebereich: [0 bis 3600]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setHeadingCallbackConfiguration() gesetzten Konfiguration

Der Parameter ist der gleiche wie getHeading().

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

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

callback BrickletCompass.MagneticFluxDensityCallback¶

Event-Objekt:	x – Typ: int, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000] y – Typ: int, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000] z – Typ: int, Einheit: 1/100 µT, Wertebereich: [-80000 bis 80000]

Dieser Callback wird periodisch ausgelöst abhängig von der mittels setMagneticFluxDensityCallbackConfiguration() gesetzten Konfiguration

Die Parameter sind der gleichen wie getMagneticFluxDensity().

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

In Octave kann diesem Callback mit addMagneticFluxDensityCallback() eine Callback-Function hinzugefügt werden. Eine hinzugefügter Callback-Function kann mit removeMagneticFluxDensityCallback() 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[] BrickletCompass.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 BrickletCompass.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:

• BrickletCompass.FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION = 2
• BrickletCompass.FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 6
• BrickletCompass.FUNCTION_SET_CONFIGURATION = 9
• BrickletCompass.FUNCTION_SET_CALIBRATION = 11
• BrickletCompass.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletCompass.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletCompass.FUNCTION_RESET = 243
• BrickletCompass.FUNCTION_WRITE_UID = 248

void BrickletCompass.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:

• BrickletCompass.FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION = 2
• BrickletCompass.FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 6
• BrickletCompass.FUNCTION_SET_CONFIGURATION = 9
• BrickletCompass.FUNCTION_SET_CALIBRATION = 11
• BrickletCompass.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletCompass.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletCompass.FUNCTION_RESET = 243
• BrickletCompass.FUNCTION_WRITE_UID = 248

void BrickletCompass.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.

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

int BrickletCompass.setBootloaderMode(int mode)¶

Parameter:	mode – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:	status – Typ: int, Wertebereich: Siehe Konstanten

Setzt den Bootloader-Modus und gibt den Status zurück nachdem die Modusänderungsanfrage bearbeitet wurde.

Mit dieser Funktion ist es möglich vom Bootloader- in den Firmware-Modus zu wechseln und umgekehrt. Ein Welchsel vom Bootloader- in der den Firmware-Modus ist nur möglich wenn Entry-Funktion, Device Identifier und CRC vorhanden und korrekt sind.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

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

Für mode:

• BrickletCompass.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletCompass.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletCompass.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletCompass.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletCompass.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BrickletCompass.BOOTLOADER_STATUS_OK = 0
• BrickletCompass.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletCompass.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletCompass.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletCompass.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletCompass.BOOTLOADER_STATUS_CRC_MISMATCH = 5

int BrickletCompass.getBootloaderMode()¶

Rückgabe:	mode – Typ: int, Wertebereich: Siehe Konstanten

Gibt den aktuellen Bootloader-Modus zurück, siehe setBootloaderMode().

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

Für mode:

• BrickletCompass.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletCompass.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletCompass.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletCompass.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletCompass.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

void BrickletCompass.setWriteFirmwarePointer(long pointer)¶

Parameter:	pointer – Typ: long, Einheit: 1 B, Wertebereich: [0 bis 232 - 1]

Setzt den Firmware-Pointer für writeFirmware(). Der Pointer muss um je 64 Byte erhöht werden. Die Daten werden alle 4 Datenblöcke in den Flash geschrieben (4 Datenblöcke entsprechen einer Page mit 256 Byte).

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

int BrickletCompass.writeFirmware(int[] data)¶

Parameter:	data – Typ: int[], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:	status – Typ: int, Wertebereich: [0 bis 255]

Schreibt 64 Bytes Firmware an die Position die vorher von setWriteFirmwarePointer() gesetzt wurde. Die Firmware wird alle 4 Datenblöcke in den Flash geschrieben.

Eine Firmware kann nur im Bootloader-Mode geschrieben werden.

Diese Funktion wird vom Brick Viewer während des Flashens benutzt. In einem normalem Nutzerprogramm sollte diese Funktion nicht benötigt werden.

void BrickletCompass.writeUID(long uid)¶

Parameter:	uid – Typ: long, Wertebereich: [0 bis 232 - 1]

Schreibt eine neue UID in den Flash. Die UID muss zuerst vom Base58 encodierten String in einen Integer decodiert werden.

Wir empfehlen die Nutzung des Brick Viewers zum ändern der UID.

long BrickletCompass.readUID()¶

Rückgabe:	uid – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt die aktuelle UID als Integer zurück. Dieser Integer kann als Base58 encodiert werden um an den üblichen UID-String zu gelangen.

Konstanten¶

int BrickletCompass.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Compass 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 BrickletCompass.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Compass Bricklet dar.