Delphi/Lazarus - Accelerometer Bricklet 2.0

Dies ist die Beschreibung der Delphi/Lazarus API Bindings für das Accelerometer Bricklet 2.0. Allgemeine Informationen über die Funktionen und technischen Spezifikationen des Accelerometer Bricklet 2.0 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
program ExampleSimple;

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

uses
  SysUtils, IPConnection, BrickletAccelerometerV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    a: TBrickletAccelerometerV2;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

procedure TExample.Execute;
var x, y, z: longint;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  a := TBrickletAccelerometerV2.Create(UID, ipcon);

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

  { Get current acceleration }
  a.GetAcceleration(x, y, z);

  WriteLn(Format('Acceleration [X]: %f g', [x/10000.0]));
  WriteLn(Format('Acceleration [Y]: %f g', [y/10000.0]));
  WriteLn(Format('Acceleration [Z]: %f g', [z/10000.0]));

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

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

Callback

Download (ExampleCallback.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
62
63
64
65
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletAccelerometerV2;

type
  TExample = class
  private
    ipcon: TIPConnection;
    a: TBrickletAccelerometerV2;
  public
    procedure AccelerationCB(sender: TBrickletAccelerometerV2; const x: longint;
                             const y: longint; const z: longint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for acceleration callback }
procedure TExample.AccelerationCB(sender: TBrickletAccelerometerV2; const x: longint;
                                  const y: longint; const z: longint);
begin
  WriteLn(Format('Acceleration [X]: %f g', [x/10000.0]));
  WriteLn(Format('Acceleration [Y]: %f g', [y/10000.0]));
  WriteLn(Format('Acceleration [Z]: %f g', [z/10000.0]));
  WriteLn('');
end;

procedure TExample.Execute;
begin
  { Create IP connection }
  ipcon := TIPConnection.Create;

  { Create device object }
  a := TBrickletAccelerometerV2.Create(UID, ipcon);

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

  { Register acceleration callback to procedure AccelerationCB }
  a.OnAcceleration := {$ifdef FPC}@{$endif}AccelerationCB;

  { Set period for acceleration callback to 1s (1000ms) }
  a.SetAccelerationCallbackConfiguration(1000, false);

  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 TBrickletAccelerometerV2.Create(const uid: string; ipcon: TIPConnection)
Parameter:
  • uid – Typ: string
  • ipcon – Typ: TIPConnection
Rückgabe:
  • accelerometerV2 – Typ: TBrickletAccelerometerV2

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

accelerometerV2 := TBrickletAccelerometerV2.Create('YOUR_DEVICE_UID', ipcon);

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

procedure TBrickletAccelerometerV2.GetAcceleration(out x: longint; out y: longint; out z: longint)
Ausgabeparameter:
  • x – Typ: longint, Einheit: 1/10000 gₙ, Wertebereich: [-80000 bis 80000]
  • y – Typ: longint, Einheit: 1/10000 gₙ, Wertebereich: [-80000 bis 80000]
  • z – Typ: longint, Einheit: 1/10000 gₙ, Wertebereich: [-80000 bis 80000]

Gibt die Beschleunigung in X-, Y- und Z-Richtung zurück. Die Werte haben die Einheit gₙ/10000 (1gₙ = 9,80665m/s²).

Wenn die Beschleunigungswerte periodisch abgefragt werden sollen, wird empfohlen den OnAcceleration Callback zu nutzen und die Periode mit SetAccelerationCallbackConfiguration vorzugeben.

procedure TBrickletAccelerometerV2.SetConfiguration(const dataRate: byte; const fullScale: byte)
Parameter:
  • dataRate – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 7
  • fullScale – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert die Datenrate und den Wertebereich. Mögliche Konfigurationswerte sind:

  • Datenrate zwischen 0,781Hz und 25600Hz.
  • Wertebereich von ±2g bis zu ±8g.

Eine Verringerung der Datenrate oder des Wertebereichs verringert auch automatisch das Rauschen auf den Daten.

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

Für dataRate:

  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_0_781HZ = 0
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_1_563HZ = 1
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_3_125HZ = 2
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_6_2512HZ = 3
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_12_5HZ = 4
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_25HZ = 5
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_50HZ = 6
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_100HZ = 7
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_200HZ = 8
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_400HZ = 9
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_800HZ = 10
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_1600HZ = 11
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_3200HZ = 12
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_6400HZ = 13
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_12800HZ = 14
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_25600HZ = 15

Für fullScale:

  • BRICKLET_ACCELEROMETER_V2_FULL_SCALE_2G = 0
  • BRICKLET_ACCELEROMETER_V2_FULL_SCALE_4G = 1
  • BRICKLET_ACCELEROMETER_V2_FULL_SCALE_8G = 2
procedure TBrickletAccelerometerV2.GetConfiguration(out dataRate: byte; out fullScale: byte)
Ausgabeparameter:
  • dataRate – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 7
  • fullScale – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für dataRate:

  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_0_781HZ = 0
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_1_563HZ = 1
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_3_125HZ = 2
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_6_2512HZ = 3
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_12_5HZ = 4
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_25HZ = 5
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_50HZ = 6
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_100HZ = 7
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_200HZ = 8
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_400HZ = 9
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_800HZ = 10
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_1600HZ = 11
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_3200HZ = 12
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_6400HZ = 13
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_12800HZ = 14
  • BRICKLET_ACCELEROMETER_V2_DATA_RATE_25600HZ = 15

Für fullScale:

  • BRICKLET_ACCELEROMETER_V2_FULL_SCALE_2G = 0
  • BRICKLET_ACCELEROMETER_V2_FULL_SCALE_4G = 1
  • BRICKLET_ACCELEROMETER_V2_FULL_SCALE_8G = 2
procedure TBrickletAccelerometerV2.SetInfoLEDConfig(const config: byte)
Parameter:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert die Info-LED (als "Force" auf dem Bricklet gekennzeichnet). Die LED kann ausgeschaltet, eingeschaltet oder im Herzschlagmodus betrieben werden.

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

Für config:

  • BRICKLET_ACCELEROMETER_V2_INFO_LED_CONFIG_OFF = 0
  • BRICKLET_ACCELEROMETER_V2_INFO_LED_CONFIG_ON = 1
  • BRICKLET_ACCELEROMETER_V2_INFO_LED_CONFIG_SHOW_HEARTBEAT = 2
function TBrickletAccelerometerV2.GetInfoLEDConfig: byte
Rückgabe:
  • config – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für config:

  • BRICKLET_ACCELEROMETER_V2_INFO_LED_CONFIG_OFF = 0
  • BRICKLET_ACCELEROMETER_V2_INFO_LED_CONFIG_ON = 1
  • BRICKLET_ACCELEROMETER_V2_INFO_LED_CONFIG_SHOW_HEARTBEAT = 2
procedure TBrickletAccelerometerV2.SetContinuousAccelerationConfiguration(const enableX: boolean; const enableY: boolean; const enableZ: boolean; const resolution: byte)
Parameter:
  • enableX – Typ: boolean, Standardwert: false
  • enableY – Typ: boolean, Standardwert: false
  • enableZ – Typ: boolean, Standardwert: false
  • resolution – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Um einen hohen Durchsatz an Beschleunigungswerten zu erreichen (> 1000Hz) müssen die OnContinuousAcceleration16Bit oder OnContinuousAcceleration8Bit Callbacks genutzt werden.

Die Callbacks können für die Achsen (x, y, z) individuell aktiviert werden. Des weiteren kann eine Auflösung von 8-Bit oder 16-Bit ausgewählt werden.

Wenn mindestens eine Achse aktiviert ist mit 8-Bit Auflösung, wird der OnContinuousAcceleration8Bit-Callback aktiviert. Wenn mindestens eine Achse aktiviert ist mit 16-Bit Auflösung, wird der OnContinuousAcceleration16Bit-Callback aktiviert.

Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit g/10000 (gleiche Einheit wie von GetAcceleration zurückgegeben) umzuwandeln. Die Formeln hängen ab von der eingestelleten Auflösung (8/16-Bit) und dem eingestellten Wertebereich (siehe SetConfiguration):

  • 16-Bit, Wertebereich 2g: Beschleunigung = Rohwert*625/1024
  • 16-Bit, Wertebereich 4g: Beschleunigung = Rohwert*1250/1024
  • 16-Bit, Wertebereich 8g: Beschleunigung = Rohwert*2500/1024

Bei einer Auflösung von 8-Bit werden nur die 8 höchstwertigen Bits übertragen, daher sehen die Formeln wie folgt aus:

  • 8-Bit, Wertebereich 2g: Beschleunigung = Rohwert*256*625/1024
  • 8-Bit, Wertebereich 4g: Beschleunigung = Rohwert*256*1250/1024
  • 8-Bit, Wertebereich 8g: Beschleunigung = Rohwert*256*2500/1024

Wenn keine Achse aktiviert is, sind beide Callbacks deaktiviert. Wenn einer der "Continuous Callbacks" genutzt wird, wird der OnAcceleration-Callback automatisch deaktiviert.

Der maximale Durchsatz hängt von der Konfiguration ab:

Anzahl aktiviert Achsen Durchsatz 8-Bit Durchsatz 16-Bit
1 25600Hz 25600Hz
2 25600Hz 15000Hz
3 20000Hz 10000Hz

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

Für resolution:

  • BRICKLET_ACCELEROMETER_V2_RESOLUTION_8BIT = 0
  • BRICKLET_ACCELEROMETER_V2_RESOLUTION_16BIT = 1
procedure TBrickletAccelerometerV2.GetContinuousAccelerationConfiguration(out enableX: boolean; out enableY: boolean; out enableZ: boolean; out resolution: byte)
Ausgabeparameter:
  • enableX – Typ: boolean, Standardwert: false
  • enableY – Typ: boolean, Standardwert: false
  • enableZ – Typ: boolean, Standardwert: false
  • resolution – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt die Konfiguration für kontinuierliche Beschleunigungswerte zurück, wie mittels SetContinuousAccelerationConfiguration gesetzt.

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

Für resolution:

  • BRICKLET_ACCELEROMETER_V2_RESOLUTION_8BIT = 0
  • BRICKLET_ACCELEROMETER_V2_RESOLUTION_16BIT = 1

Fortgeschrittene Funktionen

procedure TBrickletAccelerometerV2.SetFilterConfiguration(const iirBypass: byte; const lowPassFilter: byte)
Parameter:
  • iirBypass – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • lowPassFilter – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Konfiguriert den IIR Bypass Filter Modus und die Low Pass Filter Roll Off Corner Frequenz.

Der Filter kann angewendet oder umgangen werden und die Frequenz kann die halbe ein ein Neuntel der Ausgabe-Datenrate sein.

Accelerometer filter

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

Für iirBypass:

  • BRICKLET_ACCELEROMETER_V2_IIR_BYPASS_APPLIED = 0
  • BRICKLET_ACCELEROMETER_V2_IIR_BYPASS_BYPASSED = 1

Für lowPassFilter:

  • BRICKLET_ACCELEROMETER_V2_LOW_PASS_FILTER_NINTH = 0
  • BRICKLET_ACCELEROMETER_V2_LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

procedure TBrickletAccelerometerV2.GetFilterConfiguration(out iirBypass: byte; out lowPassFilter: byte)
Ausgabeparameter:
  • iirBypass – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0
  • lowPassFilter – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

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

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

Für iirBypass:

  • BRICKLET_ACCELEROMETER_V2_IIR_BYPASS_APPLIED = 0
  • BRICKLET_ACCELEROMETER_V2_IIR_BYPASS_BYPASSED = 1

Für lowPassFilter:

  • BRICKLET_ACCELEROMETER_V2_LOW_PASS_FILTER_NINTH = 0
  • BRICKLET_ACCELEROMETER_V2_LOW_PASS_FILTER_HALF = 1

Neu in Version 2.0.2 (Plugin).

function TBrickletAccelerometerV2.GetAPIVersion: array [0..2] of byte
Rückgabe:
  • apiVersion – Typ: array [0..2] of byte, 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.

function TBrickletAccelerometerV2.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_ACCELEROMETER_V2_FUNCTION_SET_CONFIGURATION = 2
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_SET_INFO_LED_CONFIG = 6
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_SET_FILTER_CONFIGURATION = 13
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_RESET = 243
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletAccelerometerV2.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_ACCELEROMETER_V2_FUNCTION_SET_CONFIGURATION = 2
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_SET_ACCELERATION_CALLBACK_CONFIGURATION = 4
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_SET_INFO_LED_CONFIG = 6
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_SET_CONTINUOUS_ACCELERATION_CONFIGURATION = 9
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_SET_FILTER_CONFIGURATION = 13
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_RESET = 243
  • BRICKLET_ACCELEROMETER_V2_FUNCTION_WRITE_UID = 248
procedure TBrickletAccelerometerV2.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.

procedure TBrickletAccelerometerV2.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 TBrickletAccelerometerV2.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 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:

  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletAccelerometerV2.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_ACCELEROMETER_V2_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_ACCELEROMETER_V2_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletAccelerometerV2.SetWriteFirmwarePointer(const pointer: longword)
Parameter:
  • pointer – Typ: longword, 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 TBrickletAccelerometerV2.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 TBrickletAccelerometerV2.SetStatusLEDConfig(const config: byte)
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:

  • BRICKLET_ACCELEROMETER_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_ACCELEROMETER_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_ACCELEROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_ACCELEROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletAccelerometerV2.GetStatusLEDConfig: byte
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:

  • BRICKLET_ACCELEROMETER_V2_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_ACCELEROMETER_V2_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_ACCELEROMETER_V2_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_ACCELEROMETER_V2_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletAccelerometerV2.GetChipTemperature: smallint
Rückgabe:
  • temperature – Typ: smallint, 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.

procedure TBrickletAccelerometerV2.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 TBrickletAccelerometerV2.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 TBrickletAccelerometerV2.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 TBrickletAccelerometerV2.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
  • hardwareVersion – Typ: array [0..2] of byte, Wertebereich: [0 bis 255]
  • firmwareVersion – Typ: array [0..2] of 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 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

procedure TBrickletAccelerometerV2.SetAccelerationCallbackConfiguration(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 OnAcceleration 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.

Wenn dieser Callback aktiviert ist, werden der OnContinuousAcceleration16Bit Callback und OnContinuousAcceleration8Bit Callback automatisch deaktiviert.

procedure TBrickletAccelerometerV2.GetAccelerationCallbackConfiguration(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 SetAccelerationCallbackConfiguration 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: TBrickletAccelerometerV2; const param: word);
begin
  WriteLn(param);
end;

accelerometerV2.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 TBrickletAccelerometerV2.OnAcceleration
procedure(sender: TBrickletAccelerometerV2; const x: longint; const y: longint; const z: longint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletAccelerometerV2
  • x – Typ: longint, Einheit: 1/10000 gₙ, Wertebereich: [-80000 bis 80000]
  • y – Typ: longint, Einheit: 1/10000 gₙ, Wertebereich: [-80000 bis 80000]
  • z – Typ: longint, Einheit: 1/10000 gₙ, Wertebereich: [-80000 bis 80000]

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

Die Parameter sind der gleiche wie GetAcceleration.

property TBrickletAccelerometerV2.OnContinuousAcceleration16Bit
procedure(sender: TBrickletAccelerometerV2; const acceleration: array [0..29] of smallint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletAccelerometerV2
  • acceleration – Typ: array [0..29] of smallint, Wertebereich: [-215 bis 215 - 1]

Gibt 30 Beschleunigungswerte mit 16 bit Auflösung zurück. Die Datenrate kann mit der Funktion SetConfiguration eingestellt werden und der Callback kann per SetContinuousAccelerationConfiguration aktiviert werden.

Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit g/10000 (gleiche Einheit wie von GetAcceleration zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe SetConfiguration):

  • Wertebereich 2g: Beschleunigung = Rohwert*625/1024
  • Wertebereich 4g: Beschleunigung = Rohwert*1250/1024
  • Wertebereich 8g: Beschleunigung = Rohwert*2500/1024

Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:

  • x, y, z aktiviert: "x, y, z, ... 10x ..., x, y, z"
  • x, z aktiviert: "x, z, ... 15x ..., x, z"
  • y aktiviert: "y, ... 30x ..., y"
property TBrickletAccelerometerV2.OnContinuousAcceleration8Bit
procedure(sender: TBrickletAccelerometerV2; const acceleration: array [0..59] of shortint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletAccelerometerV2
  • acceleration – Typ: array [0..59] of shortint, Wertebereich: [-128 bis 127]

Gibt 60 Beschleunigungswerte mit 8 bit Auflösung zurück. Die Datenrate kann mit der Funktion SetConfiguration eingestellt werden und der Callback kann per SetContinuousAccelerationConfiguration aktiviert werden.

Die zurückgegebenen Werte sind Rohwerte des AD-Wandlers. Wenn die Daten mit einem FFT genutzt werden sollen um Vorkomnisse from Frequenzen zu bestimmen empfehlen wir die Rohwerte direkt zu nutzen. Die Rohwerte beinhalten das Rauschen des AD-Wandlers, in diesem Rauschen können allerdings Frequenzinformation enthalten sein die für einen FFT relevant seien können.

Andernfalls können die folgenden Formeln benutzt werden um die Daten wieder in der Einheit g/10000 (gleiche Einheit wie von GetAcceleration zurückgegeben) umzuwandeln. Die Formeln hängen ab von dem eingestellten Wertebereich (siehe SetConfiguration):

  • Wertebereich 2g: Beschleunigung = Rohwert*256*625/1024
  • Wertebereich 4g: Beschleunigung = Rohwert*256*1250/1024
  • Wertebereich 8g: Beschleunigung = Rohwert*256*2500/1024

Die Daten sind in der Sequenz "x, y, z, x, y, z, ..." formatiert, abhängig von den aktivierten Achsen. Beispiele:

  • x, y, z aktiviert: "x, y, z, ... 20x ..., x, y, z"
  • x, z aktiviert: "x, z, ... 30x ..., x, z"
  • y aktiviert: "y, ... 60x ..., y"

Konstanten

const BRICKLET_ACCELEROMETER_V2_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Accelerometer Bricklet 2.0 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_ACCELEROMETER_V2_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Accelerometer Bricklet 2.0 dar.