MATLAB/Octave - IP Connection

Dies ist die Beschreibung der MATLAB/Octave API Bindings für die IP Connection. Die IP Connection kümmert sich um die Kommunikation zwischen einem Brick Daemon oder einer WIFI/Ethernet Extension. Bevor Bricks und Bricklets über deren API angesprochen werden können muss eine IP Connection erzeugt und die TCP/IP Verbindung hergestellt werden.

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

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Enumerate (MATLAB)

Download (matlab_example_enumerate.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
32
33
34
35
36
37
38
39
40
41
42
43
function matlab_example_enumerate()
    import com.tinkerforge.IPConnection;

    HOST = 'localhost';
    PORT = 4223;

    ipcon = handle(IPConnection(), 'CallbackProperties'); % Create IP connection

    ipcon.connect(HOST, PORT); % Connect to brickd

    % Register Enumerate Callback
    set(ipcon, 'EnumerateCallback', @(h, e) cb_enumerate(e));

    % Trigger Enumerate
    ipcon.enumerate();

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

% Print incoming enumeration
function cb_enumerate(e)
    ipcon = e.getSource();

    fprintf('UID: %s\n', char(e.uid));
    fprintf('Enumeration Type: %d\n', e.enumerationType);

    if e.enumerationType == ipcon.ENUMERATION_TYPE_DISCONNECTED
        fprintf('\n');
        return;
    end

    fprintf('Connected UID: %s\n', char(e.connectedUid));
    fprintf('Position: %s\n', e.position);
    fprintf('Hardware Version: ');
    fprintf('%d', rot90(e.hardwareVersion));
    fprintf('\n');
    fprintf('Firmware Version: ');
    fprintf('%d', rot90(e.firmwareVersion));
    fprintf('\n');
    fprintf('Device Identifier: %d\n', e.deviceIdentifier);
    fprintf('\n');
end

Authenticate (MATLAB)

Download (matlab_example_authenticate.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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
function matlab_example_authenticate()
    import com.tinkerforge.IPConnection;

    global SECRET;

    HOST = 'localhost';
    PORT = 4223;
    SECRET = 'My Authentication Secret!';

    ipcon = handle(IPConnection(), 'CallbackProperties'); % Create IP connection

    % Disable auto reconnect mechanism, in case we have the wrong secret.
    % If the authentication is successful, reenable it.
    ipcon.setAutoReconnect(false)

    % Register Connected Callback
    set(ipcon, 'ConnectedCallback', @(h, e) cb_connected(e));

    % Register Enumerate Callback
    set(ipcon, 'EnumerateCallback', @(h, e) cb_enumerate(e));

    ipcon.connect(HOST, PORT); % Connect to brickd

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

% Authenticate each time the connection got (re-)established
function cb_connected(e)
    ipcon = e.getSource();

    global SECRET;

    if e.connectReason == ipcon.CONNECT_REASON_REQUEST
        fprintf('Connected by request\n');
    elseif e.connectReason == ipcon.CONNECT_REASON_AUTO_RECONNECT
        fprintf('Auto-Reconnect\n');
    end

    % Authenticate first...
    try
        ipcon.authenticate(SECRET);
        fprintf('Authentication succeeded\n');
    catch ex
        fprintf('Could not authenticate\n');
        return
    end

    % ...reenable auto reconnect mechanism, as described above...
    ipcon.setAutoReconnect(true)

    % ...then trigger enumerate
    ipcon.enumerate();
end

% Print incoming enumeration
function cb_enumerate(e)
    fprintf('UID: %s, Enumeration Type: %g\n', char(e.uid), e.enumerationType);
end

Enumerate (Octave)

Download (octave_example_enumerate.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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
function octave_example_enumerate()
    more off;

    HOST = "localhost";
    PORT = 4223;

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection

    ipcon.connect(HOST, PORT); % Connect to brickd

    % Register Enumerate Callback
    ipcon.addEnumerateCallback(@cb_enumerate);

    % Trigger Enumerate
    ipcon.enumerate();

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

% Print incoming enumeration
function cb_enumerate(e)
    ipcon = e.getSource();

    fprintf("UID: %s\n", e.uid);
    fprintf("Enumeration Type: %d\n", short2int(e.enumerationType));

    if short2int(e.enumerationType) == short2int(ipcon.ENUMERATION_TYPE_DISCONNECTED)
        fprintf("\n");
        return;
    end

    hardwareVersion = e.hardwareVersion;
    firmwareVersion = e.firmwareVersion;

    fprintf("Connected UID: %s\n", e.connectedUid);
    fprintf("Position: %s\n", e.position);
    fprintf("Hardware Version: %d.%d.%d\n", short2int(hardwareVersion(1)), ...
                                            short2int(hardwareVersion(2)), ...
                                            short2int(hardwareVersion(3)));
    fprintf("Firmware Version: %d.%d.%d\n", short2int(firmwareVersion(1)), ...
                                            short2int(firmwareVersion(2)), ...
                                            short2int(firmwareVersion(3)));
    fprintf("Device Identifier: %d\n", e.deviceIdentifier);
    fprintf("\n");
end

function int = short2int(short)
    if compare_versions(version(), "3.8", "<=")
        int = short.intValue();
    else
        int = short;
    end
end

Authenticate (Octave)

Download (octave_example_authenticate.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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
function octave_example_authenticate()
    more off;

    global SECRET;

    HOST = "localhost";
    PORT = 4223;
    SECRET = "My Authentication Secret!";

    ipcon = javaObject("com.tinkerforge.IPConnection"); % Create IP connection

    % Disable auto reconnect mechanism, in case we have the wrong secret.
    % If the authentication is successful, reenable it.
    ipcon.setAutoReconnect(false)

    % Register Connected Callback
    ipcon.addConnectedCallback(@cb_connected);

    % Register Enumerate Callback
    ipcon.addEnumerateCallback(@cb_enumerate);

    ipcon.connect(HOST, PORT); % Connect to brickd

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

% Authenticate each time the connection got (re-)established
function cb_connected(e)
    ipcon = e.getSource();

    global SECRET;

    if short2int(e.connectReason) == short2int(ipcon.CONNECT_REASON_REQUEST)
        fprintf("Connected by request\n");
    elseif short2int(e.connectReason) == short2int(ipcon.CONNECT_REASON_AUTO_RECONNECT)
        fprintf("Auto-Reconnect\n");
    end

    % Authenticate first...
    try
        ipcon.authenticate(SECRET);
        fprintf("Authentication succeeded\n");
    catch ex
        fprintf("Could not authenticate\n");
        return
    end

    % ...reenable auto reconnect mechanism, as described above...
    ipcon.setAutoReconnect(true)

    % ...then trigger enumerate
    ipcon.enumerate();
end

% Print incoming enumeration
function cb_enumerate(e)
    fprintf("UID: %s, Enumeration Type: %d\n", e.uid, e.enumerationType);
end

function int = short2int(short)
    if compare_versions(version(), "3.8", "<=")
        int = short.intValue();
    else
        int = short;
    end
end

API

Grundfunktionen

public class IPConnection()

Erzeugt ein IP Connection Objekt das verwendet werden kann um die verfügbar Geräte zu enumerieren. Es wird auch für den Konstruktor von Bricks und Bricklets benötigt.

In MATLAB:

import com.tinkerforge.IPConnection;

ipcon = IPConnection();

In Octave:

ipcon = java_new("com.tinkerforge.IPConnection");
public void connect(String host, int port)

Erstellt eine TCP/IP Verbindung zum gegebenen host und port. Host und Port können auf einen Brick Daemon oder eine WIFI/Ethernet Extension verweisen.

Bricks/Bricklets können erst gesteuert werden, wenn die Verbindung erfolgreich aufgebaut wurde.

Blockiert bis die Verbindung aufgebaut wurde und gibt einen Fehlercode zurück falls kein Brick Daemon oder WIFI/Ethernet Extension auf dem gegebenen Host und Port horcht.

public void disconnect()

Trennt die TCP/IP Verbindung zum Brick Daemon oder einer WIFI/Ethernet Extension.

public void authenticate(String secret)

Führt einen Authentifizierungs-Handshake mit dem verbundenen Brick Daemon oder WIFI/Ethernet Extension durch. Ist der Handshake erfolgreich dann wechselt die Verbindung vom nicht-authentifizierten in den authentifizierten Zustand und die Kommunikation kann normal weitergeführt werden. Schlägt der Handshake fehl wird die Verbindung durch die Gegenseite geschlossen. Die Authentifizierung kann fehlschlagen wenn das Authentifizierungsgeheimnis nicht übereinstimmt oder Authentifizierung für den Brick Daemon oder die WIFI/Ethernet Extension nicht aktiviert ist.

Für mehr Informationen zur Authentifizierung siehe das dazugehörige Tutorial.

public byte getConnectionState()

Kann die folgenden Zustände zurückgeben:

  • IPConnection.CONNECTION_STATE_DISCONNECTED (0): Keine Verbindung aufgebaut.
  • IPConnection.CONNECTION_STATE_CONNECTED (1): Eine Verbindung zum Brick Daemon oder der WIFI/Ethernet Extension ist aufgebaut.
  • IPConnection.CONNECTION_STATE_PENDING (2): IP Connection versucht im Moment eine Verbindung aufzubauen.
public void setAutoReconnect(boolean autoReconnect)

Aktiviert oder deaktiviert Auto-Reconnect. Falls Auto-Reconnect aktiviert ist, versucht die IP Connection eine Verbindung zum vorher angegebenen Host und Port wieder herzustellen, falls die aktuell bestehende Verbindung verloren geht. Auto-Reconnect greift also erst nach einem erfolgreichen Aufruf von connect().

Standardwert ist true.

public boolean getAutoReconnect()

Gibt true zurück wenn Auto-Reconnect aktiviert ist und false sonst.

public void setTimeout(int timeout)

Setzt den Timeout in Millisekunden für Getter und für Setter die das Response-Expected-Flag aktiviert haben.

Standardwert ist 2500.

public int getTimeout()

Gibt den Timeout zurück, wie er von setTimeout() gesetzt wurde.

public void enumerate()

Broadcast einer Enumerierungsanfrage. Alle Bricks und Bricklets werden mit einem Enumerate Callback antworten.

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 IP Connection Objekt, der Callback-Name und die Callback-Funktion. Hier ein Beispiel in MATLAB:

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

set(ipcon, '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 IP Connection Objekts durchgeführt. Hier ein Beispiel in Octave:

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

ipcon.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.

public callback IPConnection.EnumerateCallback
Parameter:
  • uid -- String
  • connectedUid -- String
  • position -- char
  • hardwareVersion -- short[]
  • firmwareVersion -- short[]
  • deviceIdentifier -- int
  • enumerationType -- short

Der Callback empfängt sieben Parameter als Felder er Struktur e:

  • uid: Die UID des Bricks/Bricklets.
  • connectedUid: Die UID des Bricks mit dem das Brick/Bricklet verbunden ist. Für ein Bricklet ist dies die UID des Bricks mit dem es verbunden ist. Für einen Brick ist es die UID des untersten Master Bricks in einem Stapel. Der unterste Master Brick hat die Connected-UID "0". Mit diesen Informationen sollte es möglich sein die komplette Netzwerktopologie zu rekonstruieren.
  • position: Für Bricks: '0' - '8' (Position in Stapel). Für Bricklets: 'a' - 'h' (Position an Brick) oder 'i' (Position des Raspberry Pi (Zero) HAT) oder 'z' (Bricklet an Isolator Bricklet).
  • hardwareVersion: Major, Minor und Release Nummer der Hardwareversion.
  • firmwareVersion: Major, Minor und Release Nummer der Firmwareversion.
  • deviceIdentifier: Eine Zahl, welche den Brick/Bricklet repräsentiert.
  • enumerationType: Art der Enumerierung.

Mögliche Enumerierungsarten sind:

  • IPConnection.ENUMERATION_TYPE_AVAILABLE (0): Gerät ist verfügbar (Enumerierung vom Benutzer ausgelöst: enumerate()). Diese Enumerierungsart kann mehrfach für das selbe Gerät auftreten.
  • IPConnection.ENUMERATION_TYPE_CONNECTED (1): Gerät wurde neu verbunden (Automatisch vom Brick gesendet nachdem die Kommunikation aufgebaut wurde). Dies kann bedeuten, dass das Gerät die vorher eingestellte Konfiguration verloren hat und neu konfiguriert werden muss.
  • IPConnection.ENUMERATION_TYPE_DISCONNECTED (2): Gerät wurde getrennt (Nur bei USB-Verbindungen möglich). In diesem Fall haben nur uid und enumerationType einen gültigen Wert.

Es sollte möglich sein Plug-and-Play-Funktionalität mit diesem Listener zu implementieren (wie es im Brick Viewer geschieht).

Die Device Identifier Werte sind hier zu finden. Es gibt auch Konstanten für diese Werte, welche nach dem folgenden Muster benannt sind:

<device-class>.DEVICE_IDENTIFIER

Zum Beispiel: BrickMaster.DEVICE_IDENTIFIER oder BrickletAmbientLight.DEVICE_IDENTIFIER.

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

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

public callback IPConnection.ConnectedCallback
Parameter:connectReason -- short

Dieser Callback wird aufgerufen wenn die IP Connection eine Verbindung zu einem Brick Daemon oder einer WIFI/Ethernet Extension aufgebaut hat, mögliche Gründe sind:

  • IPConnection.CONNECT_REASON_REQUEST (0): Verbindung aufgebaut nach Anfrage vom Benutzer.
  • IPConnection.CONNECT_REASON_AUTO_RECONNECT (1): Verbindung aufgebaut durch Auto-Reconnect.

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

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

public callback IPConnection.DisconnectedCallback
Parameter:disconnectReason -- short

Dieser Callback wird aufgerufen wenn die Verbindung der IP Connection zu einem Brick Daemon oder einer WIFI/Ethernet Extension getrennt wurde, mögliche Gründe sind:

  • IPConnection.DISCONNECT_REASON_REQUEST (0): Trennung wurde vom Benutzer angefragt.
  • IPConnection.DISCONNECT_REASON_ERROR (1): Trennung aufgrund eines unlösbaren Problems.
  • IPConnection.DISCONNECT_REASON_SHUTDOWN (2): Trennung wurde vom Brick Daemon oder WIFI/Ethernet Extension eingeleitet.

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

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