MATLAB/Octave - Segment Display 4x7 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
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

Grundfunktionen¶

class BrickletSegmentDisplay4x7(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	segmentDisplay4x7 – Typ: BrickletSegmentDisplay4x7

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.

void BrickletSegmentDisplay4x7.setSegments(short[] segments, short brightness, boolean colon)¶

Parameter:	segments – Typ: short[], Länge: 4, Wertebereich: [0 bis 127] brightness – Typ: short, Wertebereich: [0 bis 7] colon – Typ: boolean

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

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.

BrickletSegmentDisplay4x7.Segments BrickletSegmentDisplay4x7.getSegments()¶

Rückgabeobjekt:	segments – Typ: short[], Länge: 4, Wertebereich: [0 bis 127] brightness – Typ: short, Wertebereich: [0 bis 7] colon – Typ: boolean

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

Fortgeschrittene Funktionen¶

void BrickletSegmentDisplay4x7.startCounter(short valueFrom, short valueTo, short increment, long length)¶

Parameter:	valueFrom – Typ: short, Wertebereich: [-999 bis 9999] valueTo – Typ: short, Wertebereich: [-999 bis 9999] increment – Typ: short, Wertebereich: [-999 bis 9999] length – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Starter einen Zähler mit dem from Wert der bis zum to Wert Zählt mit einer Schrittweite von increment. Das Argument length ist die Länge der Pause zwischen zwei Inkrements.

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.

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.

int BrickletSegmentDisplay4x7.getCounterValue()¶

Rückgabe:	value – Typ: int, Wertebereich: [-999 bis 9999]

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.

BrickletSegmentDisplay4x7.Identity BrickletSegmentDisplay4x7.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.

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 BrickletSegmentDisplay4x7.CounterFinishedCallback¶

Event-Objekt:	leeres Objekt

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 werden. Eine hinzugefügter Callback-Function kann mit removeCounterFinishedCallback() 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[] BrickletSegmentDisplay4x7.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 BrickletSegmentDisplay4x7.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:

• BrickletSegmentDisplay4x7.FUNCTION_SET_SEGMENTS = 1
• BrickletSegmentDisplay4x7.FUNCTION_START_COUNTER = 3

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

• BrickletSegmentDisplay4x7.FUNCTION_SET_SEGMENTS = 1
• BrickletSegmentDisplay4x7.FUNCTION_START_COUNTER = 3

void BrickletSegmentDisplay4x7.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 BrickletSegmentDisplay4x7.DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Segment Display 4x7 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 BrickletSegmentDisplay4x7.DEVICE_DISPLAY_NAME¶

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