MATLAB/Octave - Industrial Digital Out 4 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.BrickletIndustrialDigitalOut4;

    HOST = 'localhost';
    PORT = 4223;
    UID = 'XYZ'; % Change XYZ to the UID of your Industrial Digital Out 4 Bricklet

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

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

    % Set pins alternating high/low 10 times with 100ms delay
    for i = 0:9
        pause(0.1);
        ido4.setValue(bitshift(1, 0));
        pause(0.1);
        ido4.setValue(bitshift(1, 1));
        pause(0.1);
        ido4.setValue(bitshift(1, 2));
        pause(0.1);
        ido4.setValue(bitshift(1, 3));
    end

    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 Industrial Digital Out 4 Bricklet

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

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

    % Set pins alternating high/low 10 times with 100ms delay
    for i = 0:9
        pause(0.1);
        ido4.setValue(bitshift(1, 0));
        pause(0.1);
        ido4.setValue(bitshift(1, 1));
        pause(0.1);
        ido4.setValue(bitshift(1, 2));
        pause(0.1);
        ido4.setValue(bitshift(1, 3));
    end

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

Grundfunktionen¶

class BrickletIndustrialDigitalOut4(String uid, IPConnection ipcon)¶

Parameter:	uid – Typ: String ipcon – Typ: IPConnection
Rückgabe:	industrialDigitalOut4 – Typ: BrickletIndustrialDigitalOut4

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

In MATLAB:

import com.tinkerforge.BrickletIndustrialDigitalOut4;

industrialDigitalOut4 = BrickletIndustrialDigitalOut4("YOUR_DEVICE_UID", ipcon);

In Octave:

industrialDigitalOut4 = java_new("com.tinkerforge.BrickletIndustrialDigitalOut4", "YOUR_DEVICE_UID", ipcon);

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

void BrickletIndustrialDigitalOut4.setValue(int valueMask)¶

Parameter:	valueMask – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt die Ausgabewerte mit einer Bitmaske (16Bit). Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Zum Beispiel: Der Wert 3 bzw. 0b0011 wird die Pins 0-1 auf logisch 1 und alle anderen auf logisch 0 setzen.

Falls keine Gruppen verwendet werden (siehe setGroup()), entsprechen die Pins der Beschriftung auf dem Industrial Digital Out 4 Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Alle laufenden Monoflop Timer werden abgebrochen, wenn diese Funktion aufgerufen wird.

int BrickletIndustrialDigitalOut4.getValue()¶

Rückgabe:	valueMask – Typ: int, Wertebereich: [0 bis 216 - 1]

Gibt die Bitmaske zurück, wie von setValue() gesetzt.

void BrickletIndustrialDigitalOut4.setSelectedValues(int selectionMask, int valueMask)¶

Parameter:	selectionMask – Typ: int, Wertebereich: [0 bis 216 - 1] valueMask – Typ: int, Wertebereich: [0 bis 216 - 1]

Setzt die Ausgabewerte mit einer Bitmaske, entsprechend der Selektionsmaske. Die Bitmaske ist 16 Bit lang. true bedeutet logisch 1 und false logisch 0.

Zum Beispiel: Die Werte (3, 1) bzw. (0b0011, 0b0001) werden den Pin 0 auf logisch 1 und den Pin 1 auf logisch 0 setzen. Alle anderen Pins bleiben unangetastet.

Falls keine Gruppen verwendet werden (siehe setGroup()), entsprechen die Pins der Beschriftung auf dem Industrial Digital Out 4 Bricklet.

Falls Gruppen verwendet werden, entsprechen die Pins den Elementen der Gruppe. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Laufende Monoflop Timer für die ausgewählten Pins werden abgebrochen, wenn diese Funktion aufgerufen wird.

Fortgeschrittene Funktionen¶

void BrickletIndustrialDigitalOut4.setMonoflop(int selectionMask, int valueMask, long time)¶

Parameter:	selectionMask – Typ: int, Wertebereich: [0 bis 216 - 1] valueMask – Typ: int, Wertebereich: [0 bis 216 - 1] time – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Konfiguriert einen Monoflop für die Pins, wie mittels der Bitmaske des ersten Parameters festgelegt.

Der zweite Parameter ist eine Bitmaske mit den gewünschten Zuständen der festgelegten Pins. Eine 1 in der Bitmaske bedeutet logisch 1 und eine 0 in der Bitmaske bedeutet logisch 0.

Der dritte Parameter stellt die Zeit dar, welche die Pins den Zustand halten sollen.

Wenn diese Funktion mit den Parametern (9, 1, 1500) bzw. (0b1001, 0b0001, 1500) aufgerufen wird: Pin 0 wird auf logisch 1 und Pin 3 auf logisch 0 gesetzt. Nach 1,5s wird Pin 0 wieder auf logisch 0 und Pin 3 auf logisch 1 gesetzt.

Ein Monoflop kann zur Ausfallsicherung verwendet werden. Beispiel: Angenommen ein RS485 Bus und ein Digital Out 4 Bricklet ist an ein Slave Stapel verbunden. Jetzt kann diese Funktion sekündlich, mit einem Zeitparameter von 2 Sekunden, aufgerufen werden. Der Pin wird die gesamte Zeit im Zustand logisch 1 sein. Wenn jetzt die RS485 Verbindung getrennt wird, wird der Pin nach spätestens zwei Sekunden in den Zustand logisch 0 wechseln.

BrickletIndustrialDigitalOut4.Monoflop BrickletIndustrialDigitalOut4.getMonoflop(short pin)¶

Parameter:	pin – Typ: short, Wertebereich: [0 bis 15]
Rückgabeobjekt:	value – Typ: int, Wertebereich: [0 bis 1] time – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1] timeRemaining – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1]

Gibt (für den angegebenen Pin) den aktuellen Zustand und die Zeit, wie von setMonoflop() gesetzt, sowie die noch verbleibende Zeit bis zum Zustandswechsel, zurück.

Wenn der Timer aktuell nicht läuft, ist die noch verbleibende Zeit 0.

void BrickletIndustrialDigitalOut4.setGroup(char[] group)¶

Parameter:	group – Typ: char[], Länge: 4, Wertebereich: ['a' bis 'd', 'n']

Setzt eine Gruppe von Digital Out 4 Bricklets die zusammenarbeiten sollen. Mögliche Gruppierungen können mit der Funktion getAvailableForGroup() gefunden werden.

Eine Gruppe besteht aus 4 Element. Element 1 in der Gruppe bekommt Pins 0-3, Element 2 Pins 4-7, Element 3 Pins 8-11 und Element 4 Pins 12-15.

Jedes Element kann entweder auf einen der Ports ('a' bis 'd') gesetzt werden oder falls nicht genutzt 'n' gesetzt werden.

Zum Beispiel: Falls zwei Digital Out 4 Bricklets mit Port A und Port B verbunden sind, könnte diese Funktion mit ['a', 'b', 'n', 'n'] aufgerufen werden.

In diesem Fall wären die Pins von Port A den Werten 0-3 zugewiesen und die Pins von Port B den Werten 4-7. Es ist jetzt möglich mit der Funktion setValue() beide Bricklets gleichzeitig zu kontrollieren.

char[] BrickletIndustrialDigitalOut4.getGroup()¶

Rückgabe:	group – Typ: char[], Länge: 4, Wertebereich: ['a' bis 'd', 'n']

Gibt die Gruppierung zurück, wie von setGroup() gesetzt.

short BrickletIndustrialDigitalOut4.getAvailableForGroup()¶

Rückgabe:	available – Typ: short, Wertebereich: [0 bis 15]

Gibt eine Bitmaske von Ports zurück die für die Gruppierung zur Verfügung stehen. Zum Beispiel bedeutet der Wert 5 bzw. 0b0101: Port A und Port C sind mit Bricklets verbunden die zusammen gruppiert werden können.

BrickletIndustrialDigitalOut4.Identity BrickletIndustrialDigitalOut4.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 BrickletIndustrialDigitalOut4.MonoflopDoneCallback¶

Event-Objekt:	selectionMask – Typ: int, Wertebereich: [0 bis 216 - 1] valueMask – Typ: int, Wertebereich: [0 bis 216 - 1]

Dieser Callback wird ausgelöst, wenn ein Monoflop Timer abläuft (0 erreicht). Parameter enthalten die beteiligten Pins als Bitmaske und den aktuellen Zustand als Bitmaske (der Zustand nach dem Monoflop).

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

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

• BrickletIndustrialDigitalOut4.FUNCTION_SET_VALUE = 1
• BrickletIndustrialDigitalOut4.FUNCTION_SET_MONOFLOP = 3
• BrickletIndustrialDigitalOut4.FUNCTION_SET_GROUP = 5
• BrickletIndustrialDigitalOut4.FUNCTION_SET_SELECTED_VALUES = 9

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

• BrickletIndustrialDigitalOut4.FUNCTION_SET_VALUE = 1
• BrickletIndustrialDigitalOut4.FUNCTION_SET_MONOFLOP = 3
• BrickletIndustrialDigitalOut4.FUNCTION_SET_GROUP = 5
• BrickletIndustrialDigitalOut4.FUNCTION_SET_SELECTED_VALUES = 9

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

Diese Konstante wird verwendet um ein Industrial Digital Out 4 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 BrickletIndustrialDigitalOut4.DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Industrial Digital Out 4 Bricklet dar.