MATLAB/Octave - Industrial Counter Bricklet

Dies ist die Beschreibung der MATLAB/Octave API Bindings für das Industrial Counter Bricklet. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Counter 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.BrickletIndustrialCounter;

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

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

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

    % Get current counter from channel 0
    counter = ic.getCounter(BrickletIndustrialCounter.CHANNEL_0);
    fprintf('Counter (Channel 0): %i\n', counter);

    % Get current signal data from channel 0
    signalData = ic.getSignalData(BrickletIndustrialCounter.CHANNEL_0);

    fprintf('Duty Cycle (Channel 0): %g %%\n', signalData.dutyCycle/100.0);
    fprintf('Period (Channel 0): %i ns\n', signalData.period);
    fprintf('Frequency (Channel 0): %g Hz\n', signalData.frequency/1000.0);
    fprintf('Value (Channel 0): %i\n', signalData.value);

    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
29
30
31
32
33
34
35
36
function octave_example_simple()
    more off;

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

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

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

    % Get current counter from channel 0
    counter = ic.getCounter(ic.CHANNEL_0);
    fprintf("Counter (Channel 0): %d\n", java2int(counter));

    % Get current signal data from channel 0
    signalData = ic.getSignalData(ic.CHANNEL_0);

    fprintf("Duty Cycle (Channel 0): %g %%\n", signalData.dutyCycle/100.0);
    fprintf("Period (Channel 0): %d ns\n", java2int(signalData.period));
    fprintf("Frequency (Channel 0): %g Hz\n", java2int(signalData.frequency)/1000.0);
    fprintf("Value (Channel 0): %d\n", signalData.value);

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

function int = java2int(value)
    if compare_versions(version(), "3.8", "<=")
        int = value.intValue();
    else
        int = value;
    end
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

class BrickletIndustrialCounter(String uid, IPConnection ipcon)
Parameter:
  • uid – Typ: String
  • ipcon – Typ: IPConnection
Rückgabe:
  • industrialCounter – Typ: BrickletIndustrialCounter

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

In MATLAB:

import com.tinkerforge.BrickletIndustrialCounter;

industrialCounter = BrickletIndustrialCounter("YOUR_DEVICE_UID", ipcon);

In Octave:

industrialCounter = java_new("com.tinkerforge.BrickletIndustrialCounter", "YOUR_DEVICE_UID", ipcon);

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

long BrickletIndustrialCounter.getCounter(int channel)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • counter – Typ: long, Wertebereich: [-263 bis 263 - 1]

Gibt den aktuellen Zählerstand für den gegebenen Kanal zurück.

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

Für channel:

  • BrickletIndustrialCounter.CHANNEL_0 = 0
  • BrickletIndustrialCounter.CHANNEL_1 = 1
  • BrickletIndustrialCounter.CHANNEL_2 = 2
  • BrickletIndustrialCounter.CHANNEL_3 = 3
long[] BrickletIndustrialCounter.getAllCounter()
Rückgabe:
  • counter – Typ: long[], Länge: 4, Wertebereich: [-263 bis 263 - 1]

Gibt die Zählerstände für alle vier Kanäle zurück.

void BrickletIndustrialCounter.setCounter(int channel, long counter)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
  • counter – Typ: long, Wertebereich: [-263 bis 263 - 1]

Setzt den Zählerstand für den gegebenen Kanal.

Der Standardwert für alle Zähler nach dem Start ist 0.

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

Für channel:

  • BrickletIndustrialCounter.CHANNEL_0 = 0
  • BrickletIndustrialCounter.CHANNEL_1 = 1
  • BrickletIndustrialCounter.CHANNEL_2 = 2
  • BrickletIndustrialCounter.CHANNEL_3 = 3
void BrickletIndustrialCounter.setAllCounter(long[] counter)
Parameter:
  • counter – Typ: long[], Länge: 4, Wertebereich: [-263 bis 263 - 1]

Setzt die Zählerstände für alle vier Kanäle.

Der Standardwert für die Zähler nach dem Starten ist 0.

BrickletIndustrialCounter.SignalData BrickletIndustrialCounter.getSignalData(int channel)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabeobjekt:
  • dutyCycle – Typ: int, Wertebereich: [0 bis 216 - 1]
  • period – Typ: long, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: long, Wertebereich: [0 bis 232 - 1]
  • value – Typ: boolean

Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für den gegebenen Kanal.

Die Einheiten sind:

  • Tastverhältnis: 1/100 %
  • Periode: ns
  • Frequenz: mHz (1/1000 Hz)
  • Wert: true = high, false = low

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

Für channel:

  • BrickletIndustrialCounter.CHANNEL_0 = 0
  • BrickletIndustrialCounter.CHANNEL_1 = 1
  • BrickletIndustrialCounter.CHANNEL_2 = 2
  • BrickletIndustrialCounter.CHANNEL_3 = 3
BrickletIndustrialCounter.AllSignalData BrickletIndustrialCounter.getAllSignalData()
Rückgabeobjekt:
  • dutyCycle – Typ: int[], Länge: 4, Wertebereich: [0 bis 216 - 1]
  • period – Typ: long[], Länge: 4, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: long[], Länge: 4, Wertebereich: [0 bis 232 - 1]
  • value – Typ: boolean[], Länge: 4

Gibt die Signaldaten (Tastverhältnis, Periode, Frequenz und Status) für alle vier Kanäle zurück.

Die Einheiten sind:

  • Tastverhältnis: 1/100 %
  • Periode: ns
  • Frequenz: mHz (1/1000 Hz)
  • Wert: true = high, false = low
void BrickletIndustrialCounter.setCounterActive(int channel, boolean active)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
  • active – Typ: boolean

Aktiviert/Deaktiviert den Zähler für den gegebenen Kanal.

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

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

Für channel:

  • BrickletIndustrialCounter.CHANNEL_0 = 0
  • BrickletIndustrialCounter.CHANNEL_1 = 1
  • BrickletIndustrialCounter.CHANNEL_2 = 2
  • BrickletIndustrialCounter.CHANNEL_3 = 3
void BrickletIndustrialCounter.setAllCounterActive(boolean[] active)
Parameter:
  • active – Typ: boolean[], Länge: 4

Aktiviert/Deaktiviert den Zähler für alle vier Kanäle.

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

boolean BrickletIndustrialCounter.getCounterActive(int channel)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • active – Typ: boolean

Gibt den Zustand (aktiviert/deaktiviert) des gegebenen Zähler zurück.

true = aktiviert, false = deaktiviert.

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

Für channel:

  • BrickletIndustrialCounter.CHANNEL_0 = 0
  • BrickletIndustrialCounter.CHANNEL_1 = 1
  • BrickletIndustrialCounter.CHANNEL_2 = 2
  • BrickletIndustrialCounter.CHANNEL_3 = 3
boolean[] BrickletIndustrialCounter.getAllCounterActive()
Rückgabe:
  • active – Typ: boolean[], Länge: 4

Gibt den Zustand (aktiviert/deaktiviert) aller vier Zähler zurück.

true = aktiviert, false = deaktiviert.

void BrickletIndustrialCounter.setCounterConfiguration(int channel, int countEdge, int countDirection, int dutyCyclePrescaler, int frequencyIntegrationTime)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
  • countEdge – Typ: int, Wertebereich: Siehe Konstanten
  • countDirection – Typ: int, Wertebereich: Siehe Konstanten
  • dutyCyclePrescaler – Typ: int, Wertebereich: Siehe Konstanten
  • frequencyIntegrationTime – Typ: int, Wertebereich: Siehe Konstanten

Setzt die Zähler-Konfiguration für den gegebenen Kanal.

  • Zählflanke: Der Zähler kann bei der steigenden, fallenden oder beiden Flanken zählen. Standardwert ist steigend.
  • Zählrichtung: Der Zähler kann hoch- oder runterzählen. Es kann auch ein weiterer Kanal als Richtungseingang genutzt werden. Siehe hier für weitere Details. Standardwert ist hochzählend.
  • Tastverhältnis Prescaler: Setzt einen Teiler für die interne Clock. Siehe hier für weitere Details. Standardwert ist 1.
  • Frequenz-Integration: Setzt die Integrationszeit für die Frequenzmessung. Siehe hier für weitere Details. Standardwert ist 1024ms.

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

Für channel:

  • BrickletIndustrialCounter.CHANNEL_0 = 0
  • BrickletIndustrialCounter.CHANNEL_1 = 1
  • BrickletIndustrialCounter.CHANNEL_2 = 2
  • BrickletIndustrialCounter.CHANNEL_3 = 3

Für countEdge:

  • BrickletIndustrialCounter.COUNT_EDGE_RISING = 0
  • BrickletIndustrialCounter.COUNT_EDGE_FALLING = 1
  • BrickletIndustrialCounter.COUNT_EDGE_BOTH = 2

Für countDirection:

  • BrickletIndustrialCounter.COUNT_DIRECTION_UP = 0
  • BrickletIndustrialCounter.COUNT_DIRECTION_DOWN = 1
  • BrickletIndustrialCounter.COUNT_DIRECTION_EXTERNAL_UP = 2
  • BrickletIndustrialCounter.COUNT_DIRECTION_EXTERNAL_DOWN = 3

Für dutyCyclePrescaler:

  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_1 = 0
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_2 = 1
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_4 = 2
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_8 = 3
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_16 = 4
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_32 = 5
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_64 = 6
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_128 = 7
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_256 = 8
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_512 = 9
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_1024 = 10
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_2048 = 11
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_4096 = 12
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_8192 = 13
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_16384 = 14
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_32768 = 15

Für frequencyIntegrationTime:

  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_128_MS = 0
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_256_MS = 1
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_512_MS = 2
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_1024_MS = 3
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_2048_MS = 4
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_4096_MS = 5
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_8192_MS = 6
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_16384_MS = 7
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_32768_MS = 8
BrickletIndustrialCounter.CounterConfiguration BrickletIndustrialCounter.getCounterConfiguration(int channel)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabeobjekt:
  • countEdge – Typ: int, Wertebereich: Siehe Konstanten
  • countDirection – Typ: int, Wertebereich: Siehe Konstanten
  • dutyCyclePrescaler – Typ: int, Wertebereich: Siehe Konstanten
  • frequencyIntegrationTime – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Zähler-Konfiguration zurück, wie Sie mittels setCounterConfiguration() gesetzt wurde.

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

Für channel:

  • BrickletIndustrialCounter.CHANNEL_0 = 0
  • BrickletIndustrialCounter.CHANNEL_1 = 1
  • BrickletIndustrialCounter.CHANNEL_2 = 2
  • BrickletIndustrialCounter.CHANNEL_3 = 3

Für countEdge:

  • BrickletIndustrialCounter.COUNT_EDGE_RISING = 0
  • BrickletIndustrialCounter.COUNT_EDGE_FALLING = 1
  • BrickletIndustrialCounter.COUNT_EDGE_BOTH = 2

Für countDirection:

  • BrickletIndustrialCounter.COUNT_DIRECTION_UP = 0
  • BrickletIndustrialCounter.COUNT_DIRECTION_DOWN = 1
  • BrickletIndustrialCounter.COUNT_DIRECTION_EXTERNAL_UP = 2
  • BrickletIndustrialCounter.COUNT_DIRECTION_EXTERNAL_DOWN = 3

Für dutyCyclePrescaler:

  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_1 = 0
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_2 = 1
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_4 = 2
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_8 = 3
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_16 = 4
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_32 = 5
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_64 = 6
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_128 = 7
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_256 = 8
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_512 = 9
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_1024 = 10
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_2048 = 11
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_4096 = 12
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_8192 = 13
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_16384 = 14
  • BrickletIndustrialCounter.DUTY_CYCLE_PRESCALER_32768 = 15

Für frequencyIntegrationTime:

  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_128_MS = 0
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_256_MS = 1
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_512_MS = 2
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_1024_MS = 3
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_2048_MS = 4
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_4096_MS = 5
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_8192_MS = 6
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_16384_MS = 7
  • BrickletIndustrialCounter.FREQUENCY_INTEGRATION_TIME_32768_MS = 8
void BrickletIndustrialCounter.setChannelLEDConfig(int channel, int config)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
  • config – Typ: int, Wertebereich: Siehe Konstanten

Jeder Kanal hat eine dazugehörige LED. Die LEDs können individuell an- oder ausgeschaltet werden. Zusätzlich kann ein Heartbeat oder der Kanalstatus angezeigt werden. Falls Kanalstatus gewählt wird ist die LED an wenn ein High-Signal am Kanal anliegt und sonst aus.

Standardmäßig sind die LEDs für alle Kanäle auf Kanalstatus konfiguriert.

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

Für channel:

  • BrickletIndustrialCounter.CHANNEL_0 = 0
  • BrickletIndustrialCounter.CHANNEL_1 = 1
  • BrickletIndustrialCounter.CHANNEL_2 = 2
  • BrickletIndustrialCounter.CHANNEL_3 = 3

Für config:

  • BrickletIndustrialCounter.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialCounter.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialCounter.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialCounter.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
int BrickletIndustrialCounter.getChannelLEDConfig(int channel)
Parameter:
  • channel – Typ: int, Wertebereich: Siehe Konstanten
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten

Gibt die Kanal-LED-Konfiguration zurück, wie von setChannelLEDConfig() gesetzt.

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

Für channel:

  • BrickletIndustrialCounter.CHANNEL_0 = 0
  • BrickletIndustrialCounter.CHANNEL_1 = 1
  • BrickletIndustrialCounter.CHANNEL_2 = 2
  • BrickletIndustrialCounter.CHANNEL_3 = 3

Für config:

  • BrickletIndustrialCounter.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialCounter.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialCounter.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialCounter.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Fortgeschrittene Funktionen

int[] BrickletIndustrialCounter.getAPIVersion()
Rückgabe:
  • apiVersion – Typ: int[], Länge: 3, Wertebereich: [0 bis 255]

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.

boolean BrickletIndustrialCounter.getResponseExpected(int functionId)
Parameter:
  • functionId – Typ: int, 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:

  • BrickletIndustrialCounter.FUNCTION_SET_COUNTER = 3
  • BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER = 4
  • BrickletIndustrialCounter.FUNCTION_SET_COUNTER_ACTIVE = 7
  • BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
  • BrickletIndustrialCounter.FUNCTION_SET_COUNTER_CONFIGURATION = 11
  • BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
  • BrickletIndustrialCounter.FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
  • BrickletIndustrialCounter.FUNCTION_SET_CHANNEL_LED_CONFIG = 17
  • BrickletIndustrialCounter.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialCounter.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialCounter.FUNCTION_RESET = 243
  • BrickletIndustrialCounter.FUNCTION_WRITE_UID = 248
void BrickletIndustrialCounter.setResponseExpected(int functionId, boolean responseExpected)
Parameter:
  • functionId – Typ: int, 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:

  • BrickletIndustrialCounter.FUNCTION_SET_COUNTER = 3
  • BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER = 4
  • BrickletIndustrialCounter.FUNCTION_SET_COUNTER_ACTIVE = 7
  • BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
  • BrickletIndustrialCounter.FUNCTION_SET_COUNTER_CONFIGURATION = 11
  • BrickletIndustrialCounter.FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
  • BrickletIndustrialCounter.FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
  • BrickletIndustrialCounter.FUNCTION_SET_CHANNEL_LED_CONFIG = 17
  • BrickletIndustrialCounter.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialCounter.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialCounter.FUNCTION_RESET = 243
  • BrickletIndustrialCounter.FUNCTION_WRITE_UID = 248
void BrickletIndustrialCounter.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.

BrickletIndustrialCounter.SPITFPErrorCount BrickletIndustrialCounter.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.

int BrickletIndustrialCounter.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 Bootlodaer- 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:

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

Für status:

  • BrickletIndustrialCounter.BOOTLOADER_STATUS_OK = 0
  • BrickletIndustrialCounter.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIndustrialCounter.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIndustrialCounter.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIndustrialCounter.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIndustrialCounter.BOOTLOADER_STATUS_CRC_MISMATCH = 5
int BrickletIndustrialCounter.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:

  • BrickletIndustrialCounter.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialCounter.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialCounter.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialCounter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialCounter.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletIndustrialCounter.setWriteFirmwarePointer(long pointer)
Parameter:
  • pointer – Typ: long, 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 BrickletIndustrialCounter.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 BrickletIndustrialCounter.setStatusLEDConfig(int config)
Parameter:
  • config – Typ: int, Wertebereich: Siehe Konstanten

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:

  • BrickletIndustrialCounter.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialCounter.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialCounter.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialCounter.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialCounter.getStatusLEDConfig()
Rückgabe:
  • config – Typ: int, Wertebereich: Siehe Konstanten

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

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

Für config:

  • BrickletIndustrialCounter.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialCounter.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialCounter.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialCounter.STATUS_LED_CONFIG_SHOW_STATUS = 3
int BrickletIndustrialCounter.getChipTemperature()
Rückgabe:
  • temperature – Typ: int, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur in °C, 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 BrickletIndustrialCounter.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.

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

BrickletIndustrialCounter.Identity BrickletIndustrialCounter.getIdentity()
Rückgabeobjekt:
  • uid – Typ: String, Länge: bis zu 8
  • connectedUid – Typ: String, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: int[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: int[], Länge: 3, 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 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 Bricklets.

Konfigurationsfunktionen für Callbacks

void BrickletIndustrialCounter.setAllCounterCallbackConfiguration(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 AllCounterCallback 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.

BrickletIndustrialCounter.AllCounterCallbackConfiguration BrickletIndustrialCounter.getAllCounterCallbackConfiguration()
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 setAllCounterCallbackConfiguration() gesetzt.

void BrickletIndustrialCounter.setAllSignalDataCallbackConfiguration(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 AllSignalDataCallback 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.

BrickletIndustrialCounter.AllSignalDataCallbackConfiguration BrickletIndustrialCounter.getAllSignalDataCallbackConfiguration()
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 setAllSignalDataCallbackConfiguration() 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.

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.

callback BrickletIndustrialCounter.AllCounterCallback
Event-Objekt:
  • counter – Typ: long[], Länge: 4, Wertebereich: [-263 bis 263 - 1]

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

Die Parameter sind der gleiche wie getAllCounter().

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

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

callback BrickletIndustrialCounter.AllSignalDataCallback
Event-Objekt:
  • dutyCycle – Typ: int[], Länge: 4, Wertebereich: [0 bis 216 - 1]
  • period – Typ: long[], Länge: 4, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: long[], Länge: 4, Wertebereich: [0 bis 232 - 1]
  • value – Typ: boolean[], Länge: 4

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

Die Parameter sind der gleiche wie getAllSignalData().

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

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

Konstanten

int BrickletIndustrialCounter.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Counter 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 BrickletIndustrialCounter.DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Counter Bricklet dar.