Delphi/Lazarus - Industrial Counter Bricklet

Dies ist die Beschreibung der Delphi/Lazarus 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 Delphi/Lazarus API Bindings ist Teil deren allgemeine Beschreibung.

Beispiele

Der folgende Beispielcode ist Public Domain (CC0 1.0).

Simple

Download (ExampleSimple.pas)

 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
program ExampleSimple;

{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}

uses
  SysUtils, IPConnection, BrickletIndustrialCounter;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ic: TBrickletIndustrialCounter;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.Execute;
var counter: int64; dutyCycle: word; period: uint64; frequency: longword; value: boolean;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  ic := TBrickletIndustrialCounter.Create(UID, ipcon);

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

  { Get current counter from channel 0 }
  counter := ic.GetCounter(BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0);
  WriteLn(Format('Counter (Channel 0): %d', [counter]));

  { Get current signal data from channel 0 }
  ic.GetSignalData(BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0, dutyCycle, period, frequency,
                   value);

  WriteLn(Format('Duty Cycle (Channel 0): %f %%', [dutyCycle/100.0]));
  WriteLn(Format('Period (Channel 0): %d ns', [period]));
  WriteLn(Format('Frequency (Channel 0): %f Hz', [frequency/1000.0]));
  WriteLn(Format('Value (Channel 0): %d', [value]));

  WriteLn('Press key to exit');
  ReadLn;
  ipcon.Destroy; { Calls ipcon.Disconnect internally }
end;

begin
  e := TExample.Create;
  e.Execute;
  e.Destroy;
end.

API

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

Alle folgend aufgelisteten Funktionen und Prozeduren sind Thread-sicher.

Grundfunktionen

constructor TBrickletIndustrialCounter.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • industrialCounter – Typ: TBrickletIndustrialCounter

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

industrialCounter := TBrickletIndustrialCounter.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletIndustrialCounter.GetCounter(const channel: byte): int64
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • counter – Typ: int64, 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:

  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3
function TBrickletIndustrialCounter.GetAllCounter: array [0..3] of int64
Rückgabe:
  • counter – Typ: array [0..3] of int64, Wertebereich: [-263 bis 263 - 1]

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

procedure TBrickletIndustrialCounter.SetCounter(const channel: byte; const counter: int64)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • counter – Typ: int64, 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:

  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3
procedure TBrickletIndustrialCounter.SetAllCounter(const counter: array [0..3] of int64)
Parameter:
  • counter – Typ: array [0..3] of int64, 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.

procedure TBrickletIndustrialCounter.GetSignalData(const channel: byte; out dutyCycle: word; out period: uint64; out frequency: longword; out value: boolean)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • dutyCycle – Typ: word, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: uint64, Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: longword, Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: boolean

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

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

Für channel:

  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3
procedure TBrickletIndustrialCounter.GetAllSignalData(out dutyCycle: array [0..3] of word; out period: array [0..3] of uint64; out frequency: array [0..3] of longword; out value: array [0..3] of boolean)
Ausgabeparameter:
  • dutyCycle – Typ: array [0..3] of word, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: array [0..3] of uint64, Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: array [0..3] of longword, Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: array [0..3] of boolean

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

procedure TBrickletIndustrialCounter.SetCounterActive(const channel: byte; const active: boolean)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • active – Typ: boolean, Standardwert: true

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:

  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3
procedure TBrickletIndustrialCounter.SetAllCounterActive(const active: array [0..3] of boolean)
Parameter:
  • active – Typ: array [0..3] of boolean, Standardwert: (true, true, true, true)

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

true = aktivieren, false = deaktivieren.

Standardmäßig sind alle Kanäle aktiviert.

function TBrickletIndustrialCounter.GetCounterActive(const channel: byte): boolean
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • active – Typ: boolean, Standardwert: true

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:

  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3
function TBrickletIndustrialCounter.GetAllCounterActive: array [0..3] of boolean
Rückgabe:
  • active – Typ: array [0..3] of boolean, Standardwert: (true, true, true, true)

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

true = aktiviert, false = deaktiviert.

procedure TBrickletIndustrialCounter.SetCounterConfiguration(const channel: byte; const countEdge: byte; const countDirection: byte; const dutyCyclePrescaler: byte; const frequencyIntegrationTime: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • countEdge – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • countDirection – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • dutyCyclePrescaler – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • frequencyIntegrationTime – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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.
  • 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.
  • Tastverhältnis Prescaler: Setzt einen Teiler für die interne Clock. Siehe hier für weitere Details.
  • Frequenz-Integration: Setzt die Integrationszeit für die Frequenzmessung. Siehe hier für weitere Details.

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

Für channel:

  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

Für countEdge:

  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_EDGE_RISING = 0
  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_EDGE_FALLING = 1
  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_EDGE_BOTH = 2

Für countDirection:

  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_UP = 0
  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_DOWN = 1
  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_UP = 2
  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_DOWN = 3

Für dutyCyclePrescaler:

  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1 = 0
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2 = 1
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4 = 2
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8 = 3
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16 = 4
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32 = 5
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_64 = 6
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_128 = 7
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_256 = 8
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_512 = 9
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1024 = 10
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2048 = 11
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4096 = 12
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8192 = 13
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16384 = 14
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32768 = 15

Für frequencyIntegrationTime:

  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_128_MS = 0
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_256_MS = 1
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_512_MS = 2
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_1024_MS = 3
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_2048_MS = 4
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_4096_MS = 5
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_8192_MS = 6
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_16384_MS = 7
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_32768_MS = 8
procedure TBrickletIndustrialCounter.GetCounterConfiguration(const channel: byte; out countEdge: byte; out countDirection: byte; out dutyCyclePrescaler: byte; out frequencyIntegrationTime: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
Ausgabeparameter:
  • countEdge – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • countDirection – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • dutyCyclePrescaler – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • frequencyIntegrationTime – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

Für countEdge:

  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_EDGE_RISING = 0
  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_EDGE_FALLING = 1
  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_EDGE_BOTH = 2

Für countDirection:

  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_UP = 0
  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_DOWN = 1
  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_UP = 2
  • BRICKLET_INDUSTRIAL_COUNTER_COUNT_DIRECTION_EXTERNAL_DOWN = 3

Für dutyCyclePrescaler:

  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1 = 0
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2 = 1
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4 = 2
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8 = 3
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16 = 4
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32 = 5
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_64 = 6
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_128 = 7
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_256 = 8
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_512 = 9
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_1024 = 10
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_2048 = 11
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_4096 = 12
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_8192 = 13
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_16384 = 14
  • BRICKLET_INDUSTRIAL_COUNTER_DUTY_CYCLE_PRESCALER_32768 = 15

Für frequencyIntegrationTime:

  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_128_MS = 0
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_256_MS = 1
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_512_MS = 2
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_1024_MS = 3
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_2048_MS = 4
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_4096_MS = 5
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_8192_MS = 6
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_16384_MS = 7
  • BRICKLET_INDUSTRIAL_COUNTER_FREQUENCY_INTEGRATION_TIME_32768_MS = 8
procedure TBrickletIndustrialCounter.SetChannelLEDConfig(const channel: byte; const config: byte)
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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.

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

Für channel:

  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

Für config:

  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_OFF = 0
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_ON = 1
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3
function TBrickletIndustrialCounter.GetChannelLEDConfig(const channel: byte): byte
Parameter:
  • channel – Typ: byte, Wertebereich: Siehe Konstanten
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Kanal-LED-Konfiguration zurück, wie von SetChannelLEDConfig gesetzt.

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

Für channel:

  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_0 = 0
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_1 = 1
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_2 = 2
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_3 = 3

Für config:

  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_OFF = 0
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_ON = 1
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_INDUSTRIAL_COUNTER_CHANNEL_LED_CONFIG_SHOW_CHANNEL_STATUS = 3

Fortgeschrittene Funktionen

procedure TBrickletIndustrialCounter.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)
Ausgabeparameter:
  • errorCountAckChecksum – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountMessageChecksum – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountFrame – Typ: longword, Wertebereich: [0 bis 232 - 1]
  • errorCountOverflow – Typ: longword, 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.

function TBrickletIndustrialCounter.SetBootloaderMode(const mode: byte): byte
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 Bootloader- 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:

  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletIndustrialCounter.GetBootloaderMode: byte
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:

  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_INDUSTRIAL_COUNTER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletIndustrialCounter.SetWriteFirmwarePointer(const pointer: longword)
Parameter:
  • pointer – Typ: longword, Einheit: 1 B, 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.

function TBrickletIndustrialCounter.WriteFirmware(const data: array [0..63] of byte): byte
Parameter:
  • data – Typ: array [0..63] of byte, 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.

procedure TBrickletIndustrialCounter.SetStatusLEDConfig(const config: byte)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

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:

  • BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletIndustrialCounter.GetStatusLEDConfig: byte
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 3

Gibt die Konfiguration zurück, wie von SetStatusLEDConfig gesetzt.

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

Für config:

  • BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_INDUSTRIAL_COUNTER_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletIndustrialCounter.GetChipTemperature: smallint
Rückgabe:
  • temperature – Typ: smallint, Einheit: 1 °C, Wertebereich: [-215 bis 215 - 1]

Gibt die Temperatur, 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.

procedure TBrickletIndustrialCounter.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.

procedure TBrickletIndustrialCounter.WriteUID(const uid: longword)
Parameter:
  • uid – Typ: longword, 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.

function TBrickletIndustrialCounter.ReadUID: longword
Rückgabe:
  • uid – Typ: longword, 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.

procedure TBrickletIndustrialCounter.GetIdentity(out uid: string; out connectedUid: string; out position: char; out hardwareVersion: array [0..2] of byte; out firmwareVersion: array [0..2] of byte; out deviceIdentifier: word)
Ausgabeparameter:
  • uid – Typ: string, Länge: bis zu 8
  • connectedUid – Typ: string, Länge: bis zu 8
  • position – Typ: char, Wertebereich: ['a' bis 'h', 'i', 'z']
  • hardwareVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, Wertebereich: [0 bis 255]
  • deviceIdentifier – Typ: word, 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 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss) sein. Der Raspberry Pi HAT (Zero) Brick ist immer an Position 'i' und das 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.

Konfigurationsfunktionen für Callbacks

procedure TBrickletIndustrialCounter.SetAllCounterCallbackConfiguration(const period: longword; const valueHasToChange: boolean)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false

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

procedure TBrickletIndustrialCounter.GetAllCounterCallbackConfiguration(out period: longword; out valueHasToChange: boolean)
Ausgabeparameter:
  • period – Typ: longword, 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.

procedure TBrickletIndustrialCounter.SetAllSignalDataCallbackConfiguration(const period: longword; const valueHasToChange: boolean)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false

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

procedure TBrickletIndustrialCounter.GetAllSignalDataCallbackConfiguration(out period: longword; out valueHasToChange: boolean)
Ausgabeparameter:
  • period – Typ: longword, 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 erfolgt indem eine Prozedur einem Callback Property des Geräte Objektes zugewiesen wird:

procedure TExample.MyCallback(sender: TBrickletIndustrialCounter; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

industrialCounter.OnExample := {$ifdef FPC}@{$endif}example.MyCallback;

Die verfügbaren Callback Properties und ihre Parametertypen 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.

property TBrickletIndustrialCounter.OnAllCounter
procedure(sender: TBrickletIndustrialCounter; const counter: array [0..3] of int64) of object;
Callback-Parameter:
  • sender – Typ: TBrickletIndustrialCounter
  • counter – Typ: array [0..3] of int64, 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.

property TBrickletIndustrialCounter.OnAllSignalData
procedure(sender: TBrickletIndustrialCounter; const dutyCycle: array [0..3] of word; const period: array [0..3] of uint64; const frequency: array [0..3] of longword; const value: array [0..3] of boolean) of object;
Callback-Parameter:
  • sender – Typ: TBrickletIndustrialCounter
  • dutyCycle – Typ: array [0..3] of word, Einheit: 1/100 %, Wertebereich: [0 bis 10000]
  • period – Typ: array [0..3] of uint64, Einheit: 1 ns, Wertebereich: [0 bis 264 - 1]
  • frequency – Typ: array [0..3] of longword, Einheit: 1/1000 Hz, Wertebereich: [0 bis 232 - 1]
  • value – Typ: array [0..3] of boolean

Dieser Callback wird periodisch ausgelöst abhängig von der mittels SetAllSignalDataCallbackConfiguration gesetzten Konfiguration

Die Parameter sind der gleiche wie GetAllSignalData.

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.

function TBrickletIndustrialCounter.GetAPIVersion: array [0..2] of byte
Ausgabeparameter:
  • apiVersion – Typ: array [0..2] of byte
    • 0: major – Typ: byte, Wertebereich: [0 bis 255]
    • 1: minor – Typ: byte, Wertebereich: [0 bis 255]
    • 2: revision – Typ: byte, 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.

function TBrickletIndustrialCounter.GetResponseExpected(const functionId: byte): boolean
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:

  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER = 3
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER = 4
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_ACTIVE = 7
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_CONFIGURATION = 11
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_CHANNEL_LED_CONFIG = 17
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_RESET = 243
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_WRITE_UID = 248
procedure TBrickletIndustrialCounter.SetResponseExpected(const functionId: byte; const responseExpected: boolean)
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:

  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER = 3
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER = 4
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_ACTIVE = 7
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_ACTIVE = 8
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_COUNTER_CONFIGURATION = 11
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_COUNTER_CALLBACK_CONFIGURATION = 13
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_ALL_SIGNAL_DATA_CALLBACK_CONFIGURATION = 15
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_CHANNEL_LED_CONFIG = 17
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_RESET = 243
  • BRICKLET_INDUSTRIAL_COUNTER_FUNCTION_WRITE_UID = 248
procedure TBrickletIndustrialCounter.SetResponseExpectedAll(const responseExpected: boolean)
Parameter:
  • responseExpected – Typ: boolean

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

Konstanten

const BRICKLET_INDUSTRIAL_COUNTER_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Industrial Counter Bricklet zu identifizieren.

Die GetIdentity Funktion und der TIPConnection.OnEnumerate Callback der IP Connection haben ein deviceIdentifier Parameter um den Typ des Bricks oder Bricklets anzugeben.

const BRICKLET_INDUSTRIAL_COUNTER_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Industrial Counter Bricklet dar.