MATLAB/Octave - Segment Display 4x7 Bricklet

Dies ist die Beschreibung der MATLAB/Octave API Bindings für das Segment Display 4x7 Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Segment Display 4x7 Bricklet sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die MATLAB/Octave API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

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
22
23
24
25
26
27
28
29
function matlab_example_simple()
    import com.tinkerforge.IPConnection;
    import com.tinkerforge.BrickletSegmentDisplay4x7;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Segment Display 4x7 Bricklet
    DIGITS = [hex2dec('3f') hex2dec('06') hex2dec('5b') ...
              hex2dec('4f') hex2dec('66') hex2dec('6d') ...
              hex2dec('7d') hex2dec('07') hex2dec('7f') ...
              hex2dec('6f') hex2dec('77') hex2dec('7c') ...
              hex2dec('39') hex2dec('5e') hex2dec('79') ...
              hex2dec('71')]; % 0~9,A,b,C,d,E,F

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

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

    % Write "4223" to the display with full brightness without colon.
    % Adding 1 with the index because the array was designed for arrays
    % that starts with index 0 but MATLAB arrays start with index 1.
    segments = [DIGITS(4+1) DIGITS(2+1) DIGITS(2+1) DIGITS(3+1)];
    sd.setSegments(segments, 7, false);

    input('Press key to exit\n', 's');
    ipcon.disconnect();
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
21
22
23
24
25
26
27
28
function octave_example_simple()
    more off;

    HOST = "localhost";
    PORT = 4223;
    UID = "XYZ"; % Change XYZ to the UID of your Segment Display 4x7 Bricklet
    DIGITS = [hex2dec("3f") hex2dec("06") hex2dec("5b") ...
              hex2dec("4f") hex2dec("66") hex2dec("6d") ...
              hex2dec("7d") hex2dec("07") hex2dec("7f") ...
              hex2dec("6f") hex2dec("77") hex2dec("7c") ...
              hex2dec("39") hex2dec("5e") hex2dec("79") ...
              hex2dec("71")]; % 0~9,A,b,C,d,E,F

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

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

    % Write "4223" to the display with full brightness without colon.
    % Adding 1 with the index because the array was designed for arrays
    % that starts with index 0 but Octave arrays start with index 1.
    segments = [DIGITS(4+1) DIGITS(2+1) DIGITS(2+1) DIGITS(3+1)];
    sd.setSegments(segments, 7, false);

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

API

Prinzipiell kann jede Methode der MATLAB Bindings eine TimeoutException werfen. Diese Exception wird geworfen wenn das Gerät nicht antwortet. Wenn eine Kabelverbindung genutzt wird, ist es unwahrscheinlich, dass die Exception geworfen wird (unter der Annahme, dass das Gerät nicht abgesteckt wird). Bei einer drahtlosen Verbindung können Zeitüberschreitungen auftreten, sobald die Entfernung zum Gerät zu groß wird.

Neben der TimeoutException kann auch noch eine NotConnectedException geworfen werden, wenn versucht wird mit einem Brick oder Bricklet zu kommunizieren, aber die IP Connection nicht verbunden ist.

Da die MATLAB Bindings auf Java basieren und Java nicht mehrere Rückgabewerte unterstützt und eine Referenzrückgabe für elementare Type nicht möglich ist, werden kleine Klassen verwendet, die nur aus Member-Variablen bestehen. Die Member-Variablen des zurückgegebenen Objektes werden in der jeweiligen Methodenbeschreibung erläutert.

Das Package für alle Brick/Bricklet Bindings und die IP Connection ist com.tinkerforge.*

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

public class BrickletSegmentDisplay4x7(String uid, IPConnection ipcon)

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

In MATLAB:

import com.tinkerforge.BrickletSegmentDisplay4x7;

segmentDisplay4x7 = BrickletSegmentDisplay4x7("YOUR_DEVICE_UID", ipcon);

In Octave:

segmentDisplay4x7 = java_new("com.tinkerforge.BrickletSegmentDisplay4x7", "YOUR_DEVICE_UID", ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist (siehe Beispiele oben).

public void setSegments(short[] segments, short brightness, boolean colon)

Die 7-Segment-Anzeige kann mit Bitmaps gesetzt werden. Jedes Bit kontrolliert ein Segment:

Bitreihenfolge eines Segments

Beispiel: Um eine "5" auf der Anzeige darzustellen müssen die Segment 0, 2, 3, 5 und 6 aktiviert werden. Dies kann mit der Zahl 0b01101101 = 0x6d = 109 repräsentiert werden.

Die Helligkeit kann zwischen 0 (dunkel) und 7 (hell) gesetzt werden. Der dritte Parameter aktiviert/deaktiviert den Doppelpunkt auf der Anzeige.

public BrickletSegmentDisplay4x7.Segments getSegments()

Gibt die Segment-, Helligkeit- und Doppelpunktdaten zurück, wie von setSegments() gesetzt.

Das zurückgegebene Objekt enthält die Public-Member-Variablen short[] segments, short brightness und boolean colon.

Fortgeschrittene Funktionen

public void startCounter(short valueFrom, short valueTo, short increment, long length)

Starter einen Zähler mit dem from Wert der bis zum to Wert Zählt mit einer Schrittweite von increment. Das Argument length gibt die Pause zwischen den Erhöhungen in ms an.

Beispiel: Wenn from auf 0, to auf 100, increment auf 1 und length auf 1000 gesetzt wird, wird ein Zähler gestartet der von 0 bis 100 zählt mit Rate von einer Sekunde zwischen jeder Erhöhung.

Der Maximalwert für from, to und increment ist 9999, der Minimalwert ist -999.

Wenn das increment negativ ist läuft der Zähler rückwärts.

Der Zähler kann jederzeit durch einen Aufruf von setSegments() gestoppt werden.

public int getCounterValue()

Gibt den aktuellen Zählerstand zurück der auf der Anzeige angezeigt wird.

Wenn kein Zähler am laufen ist wird eine 0 zurückgegeben.

public short[] getAPIVersion()

Gibt die Version der API Definition (Major, Minor, Revision) 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.

public boolean getResponseExpected(short functionId)

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.

Siehe setResponseExpected() für die Liste der verfügbaren Funktions ID Konstanten für diese Funktion.

public void setResponseExpected(short functionId, boolean responseExpected)

Ä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 Funktions ID Konstanten sind für diese Funktion verfügbar:

  • BrickletSegmentDisplay4x7.FUNCTION_SET_SEGMENTS = 1
  • BrickletSegmentDisplay4x7.FUNCTION_START_COUNTER = 3
public void setResponseExpectedAll(boolean responseExpected)

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

public BrickletSegmentDisplay4x7.Identity getIdentity()

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 kann 'a', 'b', 'c' oder 'd' sein.

Eine Liste der Device Identifier Werte ist hier zu finden. Es gibt auch eine Konstante für den Device Identifier dieses Bricklet.

Das zurückgegebene Objekt enthält die Public-Member-Variablen String uid, String connectedUid, char position, short[] hardwareVersion, short[] firmwareVersion und int deviceIdentifier.

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.

Bemerkung

Callbacks für wiederkehrende Ereignisse zu verwenden ist immer zu bevorzugen gegenüber der Verwendung von Abfragen. Es wird weniger USB-Bandbreite benutzt und die Latenz ist erheblich geringer, da es keine Paketumlaufzeit gibt.

public callback BrickletSegmentDisplay4x7.CounterFinishedCallback

Diese Callback wird ausgelöst wenn der Zähler (siehe startCounter()) fertig ist.

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

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

Konstanten

public static final int BrickletSegmentDisplay4x7.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Segment Display 4x7 Bricklet zu identifizieren.

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

public static final String BrickletSegmentDisplay4x7.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Segment Display 4x7 Bricklet dar.