C# - Industrial Digital In 4 Bricklet 2.0

Dies ist die Beschreibung der C# API Bindings für das Industrial Digital In 4 Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Industrial Digital In 4 Bricklet 2.0 sind in dessen Hardware Beschreibung zusammengefasst.

Eine Installationanleitung für die C# API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.cs)

 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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletIndustrialDigitalIn4V2 idi4 =
          new BrickletIndustrialDigitalIn4V2(UID, ipcon); // Create device object

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

        // Get current value
        bool[] value = idi4.GetValue();

        Console.WriteLine("Channel 0: " + value[0]);
        Console.WriteLine("Channel 1: " + value[1]);
        Console.WriteLine("Channel 2: " + value[2]);
        Console.WriteLine("Channel 3: " + value[3]);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Edge Count

Download (ExampleEdgeCount.cs)

 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
using System;
using System.Threading;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletIndustrialDigitalIn4V2 idi4 =
          new BrickletIndustrialDigitalIn4V2(UID, ipcon); // Create device object

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

        // Configure rising edge count (channel 3) with 10ms debounce
        idi4.SetEdgeCountConfiguration(3, 0, 10);

        // Get edge count 10 times with 1s delay
        for(int i = 0; i < 10; i++)
        {
            Thread.Sleep(1000);

            // Get current edge count
            long count = idi4.GetEdgeCount(3, false);
            Console.WriteLine("Count: " + count);
        }

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

Callback

Download (ExampleCallback.cs)

 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
using System;
using Tinkerforge;

class Example
{
    private static string HOST = "localhost";
    private static int PORT = 4223;
    private static string UID = "XYZ"; // Change XYZ to the UID of your Industrial Digital In 4 Bricklet 2.0

    // Callback function for value callback
    static void ValueCB(BrickletIndustrialDigitalIn4V2 sender, byte channel, bool changed,
                        bool value)
    {
        if(channel == BrickletIndustrialDigitalIn4V2.CHANNEL_0)
        {
            Console.WriteLine("Channel: 0");
        }
        else if(channel == BrickletIndustrialDigitalIn4V2.CHANNEL_1)
        {
            Console.WriteLine("Channel: 1");
        }
        else if(channel == BrickletIndustrialDigitalIn4V2.CHANNEL_2)
        {
            Console.WriteLine("Channel: 2");
        }
        else if(channel == BrickletIndustrialDigitalIn4V2.CHANNEL_3)
        {
            Console.WriteLine("Channel: 3");
        }

        Console.WriteLine("Changed: " + changed);
        Console.WriteLine("Value: " + value);
        Console.WriteLine("");
    }

    static void Main()
    {
        IPConnection ipcon = new IPConnection(); // Create IP connection
        BrickletIndustrialDigitalIn4V2 idi4 =
          new BrickletIndustrialDigitalIn4V2(UID, ipcon); // Create device object

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

        // Register value callback to function ValueCB
        idi4.ValueCallback += ValueCB;

        // Set period for value (channel 1) callback to 0.1s (100ms)
        idi4.SetValueCallbackConfiguration(1, 100, false);

        Console.WriteLine("Press enter to exit");
        Console.ReadLine();
        ipcon.Disconnect();
    }
}

API

Prinzipiell kann jede Funktion der C# Bindings, welche einen Wert zurück gibt eine Tinkerforge.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.

Da C# nicht mehrere Rückgabewerte direkt unterstützt, wird das out Schlüsselwort genutzt, um mehrere Werte aus einer Funktion zurückzugeben.

Der Namensraum für alle Brick/Bricklet Bindings und die IPConnection ist Tinkerforge.*.

Alle folgend aufgelisteten Methoden sind Thread-sicher.

Grundfunktionen

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

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

BrickletIndustrialDigitalIn4V2 industrialDigitalIn4V2 = new BrickletIndustrialDigitalIn4V2("YOUR_DEVICE_UID", ipcon);

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

bool[] BrickletIndustrialDigitalIn4V2.GetValue()
Rückgabe:
  • value – Typ: bool[], Länge: 4

Gibt die Eingangswerte als Bools zurück, true bedeutet logisch 1 und false logisch 0.

void BrickletIndustrialDigitalIn4V2.SetChannelLEDConfig(byte channel, byte config)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • config – Typ: byte, 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:

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

Für config:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
byte BrickletIndustrialDigitalIn4V2.GetChannelLEDConfig(byte channel)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • config – Typ: byte, 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:

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

Für config:

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

Fortgeschrittene Funktionen

long BrickletIndustrialDigitalIn4V2.GetEdgeCount(byte channel, bool resetCounter)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • resetCounter – Typ: bool
Rückgabe:
  • count – Typ: long, Wertebereich: [0 bis 232 - 1]

Gibt den aktuellen Wert des Flankenzählers für den ausgewählten Kanal zurück. Die zu zählenden Flanken können mit SetEdgeCountConfiguration() konfiguriert werden.

Wenn reset counter auf true gesetzt wird, wird der Zählerstand direkt nach dem auslesen auf 0 zurückgesetzt.

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

Für channel:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
void BrickletIndustrialDigitalIn4V2.SetEdgeCountConfiguration(byte channel, byte edgeType, byte debounce)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • edgeType – Typ: byte, Wertebereich: Siehe Konstanten
  • debounce – Typ: byte, Wertebereich: [0 bis 255]

Konfiguriert den Flankenzähler für einen bestimmten Kanal.

Der edge type Parameter konfiguriert den zu zählenden Flankentyp. Es können steigende, fallende oder beide Flanken gezählt werden. Mögliche Flankentypen sind:

  • 0 = steigend (Standard)
  • 1 = fallend
  • 2 = beide

Die Entprellzeit (debounce) wird in ms angegeben.

Durch das Konfigurieren wird der Wert des Flankenzählers auf 0 zurückgesetzt.

Falls unklar ist was dies alles bedeutet, kann diese Funktion einfach ignoriert werden. Die Standardwerte sind in fast allen Situationen OK.

Standardwerte: 0 (edge type) und 100ms (debounce).

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

Für channel:

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

Für edgeType:

  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2
void BrickletIndustrialDigitalIn4V2.GetEdgeCountConfiguration(byte channel, out byte edgeType, out byte debounce)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • edgeType – Typ: byte, Wertebereich: Siehe Konstanten
  • debounce – Typ: byte, Wertebereich: [0 bis 255]

Gibt den Flankentyp sowie die Entprellzeit für den ausgewählten Kanals zurück, wie von SetEdgeCountConfiguration() gesetzt.

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

Für channel:

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

Für edgeType:

  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_RISING = 0
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_FALLING = 1
  • BrickletIndustrialDigitalIn4V2.EDGE_TYPE_BOTH = 2
byte[] BrickletIndustrialDigitalIn4V2.GetAPIVersion()
Rückgabe:
  • apiVersion – Typ: byte[], 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.

bool BrickletIndustrialDigitalIn4V2.GetResponseExpected(byte functionId)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • responseExpected – Typ: bool

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:

  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalIn4V2.FUNCTION_RESET = 243
  • BrickletIndustrialDigitalIn4V2.FUNCTION_WRITE_UID = 248
void BrickletIndustrialDigitalIn4V2.SetResponseExpected(byte functionId, bool responseExpected)
Parameter:
  • functionId – Typ: byte, Wertebereich: Siehe Konstanten
  • responseExpected – Typ: bool

Ä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:

  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_VALUE_CALLBACK_CONFIGURATION = 2
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_ALL_VALUE_CALLBACK_CONFIGURATION = 4
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_EDGE_COUNT_CONFIGURATION = 7
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_CHANNEL_LED_CONFIG = 9
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletIndustrialDigitalIn4V2.FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletIndustrialDigitalIn4V2.FUNCTION_RESET = 243
  • BrickletIndustrialDigitalIn4V2.FUNCTION_WRITE_UID = 248
void BrickletIndustrialDigitalIn4V2.SetResponseExpectedAll(bool responseExpected)
Parameter:
  • responseExpected – Typ: bool

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

void BrickletIndustrialDigitalIn4V2.GetSPITFPErrorCount(out long errorCountAckChecksum, out long errorCountMessageChecksum, out long errorCountFrame, out long errorCountOverflow)
Ausgabeparameter:
  • 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.

byte BrickletIndustrialDigitalIn4V2.SetBootloaderMode(byte mode)
Parameter:
  • mode – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • status – Typ: byte, 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:

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

Für status:

  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_OK = 0
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_STATUS_CRC_MISMATCH = 5
byte BrickletIndustrialDigitalIn4V2.GetBootloaderMode()
Rückgabe:
  • mode – Typ: byte, 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:

  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletIndustrialDigitalIn4V2.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
void BrickletIndustrialDigitalIn4V2.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.

byte BrickletIndustrialDigitalIn4V2.WriteFirmware(byte[] data)
Parameter:
  • data – Typ: byte[], Länge: 64, Wertebereich: [0 bis 255]
Rückgabe:
  • status – Typ: byte, 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 BrickletIndustrialDigitalIn4V2.SetStatusLEDConfig(byte config)
Parameter:
  • config – Typ: byte, 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:

  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
byte BrickletIndustrialDigitalIn4V2.GetStatusLEDConfig()
Rückgabe:
  • config – Typ: byte, 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:

  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_OFF = 0
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_ON = 1
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletIndustrialDigitalIn4V2.STATUS_LED_CONFIG_SHOW_STATUS = 3
short BrickletIndustrialDigitalIn4V2.GetChipTemperature()
Rückgabe:
  • temperature – Typ: short, 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 BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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 BrickletIndustrialDigitalIn4V2.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.

void BrickletIndustrialDigitalIn4V2.GetIdentity(out string uid, out string connectedUid, out char position, out byte[] hardwareVersion, out byte[] firmwareVersion, out int deviceIdentifier)
Ausgabeparameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char
  • hardwareVersion – Typ: byte[], Länge: 3, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: byte[], 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 BrickletIndustrialDigitalIn4V2.SetValueCallbackConfiguration(byte channel, long period, bool valueHasToChange)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false

Dieser Callback kann pro Kanal konfiguriert werden.

Die Periode ist die Periode mit der der ValueCallback 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.

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

Für channel:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
void BrickletIndustrialDigitalIn4V2.GetValueCallbackConfiguration(byte channel, out long period, out bool valueHasToChange)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration für den gegebenen Kanal zurück, wie mittels SetValueCallbackConfiguration() gesetzt.

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

Für channel:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
void BrickletIndustrialDigitalIn4V2.SetAllValueCallbackConfiguration(long period, bool valueHasToChange)
Parameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false

Die Periode ist die Periode mit der der AllValueCallback 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.

void BrickletIndustrialDigitalIn4V2.GetAllValueCallbackConfiguration(out long period, out bool valueHasToChange)
Ausgabeparameter:
  • period – Typ: long, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: bool, Standardwert: false

Gibt die Callback-Konfiguration zurück, wie mittels SetAllValueCallbackConfiguration() gesetzt.

Callbacks

Callbacks können registriert werden um zeitkritische oder wiederkehrende Daten vom Gerät zu erhalten. Die Registrierung geschieht durch Anhängen des Callback Handlers an den passenden Event:

void MyCallback(BrickletIndustrialDigitalIn4V2 sender, int value)
{
    System.Console.WriteLine("Value: " + value);
}

industrialDigitalIn4V2.ExampleCallback += MyCallback;

Die verfügbaren Events werden weiter unten 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.

event BrickletIndustrialDigitalIn4V2.ValueCallback(BrickletIndustrialDigitalIn4V2 sender, byte channel, bool changed, bool value)
Callback-Parameter:
  • sender – Typ: BrickletIndustrialDigitalIn4V2
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • changed – Typ: bool
  • value – Typ: bool

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

Die Parameter sind der Kanal, Changed und der Wert. Der changed-Parameter ist True wenn sich der Wert seit dem letzten Callback geändert hat.

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

Für channel:

  • BrickletIndustrialDigitalIn4V2.CHANNEL_0 = 0
  • BrickletIndustrialDigitalIn4V2.CHANNEL_1 = 1
  • BrickletIndustrialDigitalIn4V2.CHANNEL_2 = 2
  • BrickletIndustrialDigitalIn4V2.CHANNEL_3 = 3
event BrickletIndustrialDigitalIn4V2.AllValueCallback(BrickletIndustrialDigitalIn4V2 sender, bool[] changed, bool[] value)
Callback-Parameter:
  • sender – Typ: BrickletIndustrialDigitalIn4V2
  • changed – Typ: bool[], Länge: 4
  • value – Typ: bool[], Länge: 4

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

Die Parameter sind der gleiche wie GetValue(). Zusätzlich ist der changed-Parameter True wenn sich der Wert seit dem letzten Callback geändert hat.

Konstanten

int BrickletIndustrialDigitalIn4V2.DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Digital In 4 Bricklet 2.0 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 BrickletIndustrialDigitalIn4V2.DEVICE_DISPLAY_NAME

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