Delphi/Lazarus - Compass Bricklet

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

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

uses
  SysUtils, IPConnection, BrickletCompass;

type
  TExample = class
  private
    ipcon: TIPConnection;
    c: TBrickletCompass;
  public
    procedure Execute;
  end;

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

var
  e: TExample;

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

  { Create device object }
  c := TBrickletCompass.Create(UID, ipcon);

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

  { Get current heading }
  heading := c.GetHeading;
  WriteLn(Format('Heading: %f °', [heading/10.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
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletCompass;

type
  TExample = class
  private
    ipcon: TIPConnection;
    c: TBrickletCompass;
  public
    procedure HeadingCB(sender: TBrickletCompass; const heading: smallint);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for heading callback }
procedure TExample.HeadingCB(sender: TBrickletCompass; const heading: smallint);
begin
  WriteLn(Format('Heading: %f °', [heading/10.0]));
end;

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

  { Create device object }
  c := TBrickletCompass.Create(UID, ipcon);

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

  { Register heading callback to procedure HeadingCB }
  c.OnHeading := {$ifdef FPC}@{$endif}HeadingCB;

  { Set period for heading callback to 0.1s (100ms) without a threshold }
  c.SetHeadingCallbackConfiguration(100, false, 'x', 0, 0);

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

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

compass := TBrickletCompass.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletCompass.GetHeading: smallint
Rückgabe:
  • heading – Typ: smallint, Wertebereich: [-215 bis 215 - 1]

Gibt die Richtung in 1/10 Grad zurück (Norden = 0 Grad, Osten = 90 Grad).

Alternativ kann die Funktion GetMagneticFluxDensity genutzt werden um die Richtung per heading = atan2(y, x) * 180 / PI zu bestimmen.

Wenn der Wert periodisch benötigt wird, kann auch der OnHeading Callback verwendet werden. Der Callback wird mit der Funktion SetHeadingCallbackConfiguration konfiguriert.

procedure TBrickletCompass.GetMagneticFluxDensity(out x: longint; out y: longint; out z: longint)
Ausgabeparameter:
  • x – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • y – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • z – Typ: longint, Wertebereich: [-231 bis 231 - 1]

Gibt die magnetische Flussdichte (magnetische Induktion) für alle drei Achsen in 1/10 mG (Milligauß) zurück.

Wenn der Wert periodisch benötigt wird, kann auch der OnMagneticFluxDensity Callback verwendet werden. Der Callback wird mit der Funktion SetMagneticFluxDensityCallbackConfiguration konfiguriert.

procedure TBrickletCompass.SetConfiguration(const dataRate: byte; const backgroundCalibration: boolean)
Parameter:
  • dataRate – Typ: byte, Wertebereich: Siehe Konstanten
  • backgroundCalibration – Typ: boolean

Konfiguriert die Datenrate und Hintergrundkalibrierung:

  • Data Rate: Setzt die Datenrate des eingesetzten Magnetometers. Je niedriger die Datenrate ist, desto weniger Rauschen befindet sich auf den Daten.
  • Background Calibration: Aktiviert die automatische Hintergrundkalibrierung, wenn auf true gesetzt. Wenn die Hintergrundkalibrierung aktiviert ist, ändert das Bricklet einmal pro Sekunde die Erfassungspolarität, um damit automatisch temperaturabhängige Offsets zu entfernen. Das Ändern der Polarität dauert ungefähr 20ms. Daher werden einmal pro Sekunde für 20ms keine neuen Daten generiert, wenn die Kalibrierung aktiviert ist. Wir empfehlen die Kalibrierung nur zu deaktivieren, falls diese 20ms Auszeit ein großes Problem in der Anwendung des Bricklets darstellen.

Standardwerte: Datenrate 100Hz und Hintergrundkalibrierung aktiviert.

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

Für dataRate:

  • BRICKLET_COMPASS_DATA_RATE_100HZ = 0
  • BRICKLET_COMPASS_DATA_RATE_200HZ = 1
  • BRICKLET_COMPASS_DATA_RATE_400HZ = 2
  • BRICKLET_COMPASS_DATA_RATE_600HZ = 3
procedure TBrickletCompass.GetConfiguration(out dataRate: byte; out backgroundCalibration: boolean)
Ausgabeparameter:
  • dataRate – Typ: byte, Wertebereich: Siehe Konstanten
  • backgroundCalibration – Typ: boolean

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

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

Für dataRate:

  • BRICKLET_COMPASS_DATA_RATE_100HZ = 0
  • BRICKLET_COMPASS_DATA_RATE_200HZ = 1
  • BRICKLET_COMPASS_DATA_RATE_400HZ = 2
  • BRICKLET_COMPASS_DATA_RATE_600HZ = 3

Fortgeschrittene Funktionen

procedure TBrickletCompass.SetCalibration(const offset: array [0..2] of smallint; const gain: array [0..2] of smallint)
Parameter:
  • offset – Typ: array [0..2] of smallint, Wertebereich: [-215 bis 215 - 1]
  • gain – Typ: array [0..2] of smallint, Wertebereich: [-215 bis 215 - 1]

Setzt Offset und Gain für alle drei Achsen.

Das Bricklet ist ab Werk kalibriert. Wenn eine Rekalibrierung durchgeführt werden soll, empfehlen wir dafür den Brick Viewer zu nutzen.

Die Kalibrierung wird in nicht-flüchtigem Speicher gespeichert und muss nur einmal durchgeführt werden.

procedure TBrickletCompass.GetCalibration(out offset: array [0..2] of smallint; out gain: array [0..2] of smallint)
Ausgabeparameter:
  • offset – Typ: array [0..2] of smallint, Wertebereich: [-215 bis 215 - 1]
  • gain – Typ: array [0..2] of smallint, Wertebereich: [-215 bis 215 - 1]

Gibt die Kalibrierungsparameter zurück, wie von SetCalibration gesetzt.

function TBrickletCompass.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 TBrickletCompass.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_COMPASS_FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION = 2
  • BRICKLET_COMPASS_FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 6
  • BRICKLET_COMPASS_FUNCTION_SET_CONFIGURATION = 9
  • BRICKLET_COMPASS_FUNCTION_SET_CALIBRATION = 11
  • BRICKLET_COMPASS_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_COMPASS_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_COMPASS_FUNCTION_RESET = 243
  • BRICKLET_COMPASS_FUNCTION_WRITE_UID = 248
procedure TBrickletCompass.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_COMPASS_FUNCTION_SET_HEADING_CALLBACK_CONFIGURATION = 2
  • BRICKLET_COMPASS_FUNCTION_SET_MAGNETIC_FLUX_DENSITY_CALLBACK_CONFIGURATION = 6
  • BRICKLET_COMPASS_FUNCTION_SET_CONFIGURATION = 9
  • BRICKLET_COMPASS_FUNCTION_SET_CALIBRATION = 11
  • BRICKLET_COMPASS_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BRICKLET_COMPASS_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BRICKLET_COMPASS_FUNCTION_RESET = 243
  • BRICKLET_COMPASS_FUNCTION_WRITE_UID = 248
procedure TBrickletCompass.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 TBrickletCompass.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 TBrickletCompass.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_COMPASS_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_COMPASS_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_COMPASS_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_COMPASS_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_COMPASS_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

  • BRICKLET_COMPASS_BOOTLOADER_STATUS_OK = 0
  • BRICKLET_COMPASS_BOOTLOADER_STATUS_INVALID_MODE = 1
  • BRICKLET_COMPASS_BOOTLOADER_STATUS_NO_CHANGE = 2
  • BRICKLET_COMPASS_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BRICKLET_COMPASS_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BRICKLET_COMPASS_BOOTLOADER_STATUS_CRC_MISMATCH = 5
function TBrickletCompass.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_COMPASS_BOOTLOADER_MODE_BOOTLOADER = 0
  • BRICKLET_COMPASS_BOOTLOADER_MODE_FIRMWARE = 1
  • BRICKLET_COMPASS_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BRICKLET_COMPASS_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BRICKLET_COMPASS_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
procedure TBrickletCompass.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 TBrickletCompass.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 TBrickletCompass.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_COMPASS_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_COMPASS_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_COMPASS_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_COMPASS_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletCompass.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_COMPASS_STATUS_LED_CONFIG_OFF = 0
  • BRICKLET_COMPASS_STATUS_LED_CONFIG_ON = 1
  • BRICKLET_COMPASS_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BRICKLET_COMPASS_STATUS_LED_CONFIG_SHOW_STATUS = 3
function TBrickletCompass.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 TBrickletCompass.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 TBrickletCompass.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 TBrickletCompass.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 TBrickletCompass.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 TBrickletCompass.SetHeadingCallbackConfiguration(const period: longword; const valueHasToChange: boolean; const option: char; const min: smallint; const max: smallint)
Parameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: smallint, Wertebereich: [-215 bis 215 - 1]
  • max – Typ: smallint, Wertebereich: [-215 bis 215 - 1]

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

Desweiteren ist es möglich den Callback mittels Thresholds einzuschränken.

Der option-Parameter zusammen mit min/max setzt einen Threshold für den OnHeading Callback.

Die folgenden Optionen sind möglich:

Option Beschreibung
'x' Threshold ist abgeschaltet
'o' Threshold wird ausgelöst, wenn der Wert außerhalb der Min und Max Werte sind
'i' Threshold wird ausgelöst, wenn der Wert innerhalb der Min und Max Werte sind
'<' Threshold wird ausgelöst, wenn der Wert kleiner ist wie der Min Wert (Max wird ignoriert)
'>' Threshold wird ausgelöst, wenn der Wert größer ist wie der Max Wert (Min wird ignoriert)

Wird die Option auf 'x' gesetzt (Threshold abgeschaltet), so wird der Callback mit der festen Periode ausgelöst.

Der Standardwert ist (0, false, 'x', 0, 0).

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

Für option:

  • BRICKLET_COMPASS_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_COMPASS_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_COMPASS_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_COMPASS_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_COMPASS_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletCompass.GetHeadingCallbackConfiguration(out period: longword; out valueHasToChange: boolean; out option: char; out min: smallint; out max: smallint)
Ausgabeparameter:
  • period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0
  • valueHasToChange – Typ: boolean, Standardwert: false
  • option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x'
  • min – Typ: smallint, Wertebereich: [-215 bis 215 - 1]
  • max – Typ: smallint, Wertebereich: [-215 bis 215 - 1]

Gibt die Callback-Konfiguration zurück, wie mittels SetHeadingCallbackConfiguration gesetzt.

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

Für option:

  • BRICKLET_COMPASS_THRESHOLD_OPTION_OFF = 'x'
  • BRICKLET_COMPASS_THRESHOLD_OPTION_OUTSIDE = 'o'
  • BRICKLET_COMPASS_THRESHOLD_OPTION_INSIDE = 'i'
  • BRICKLET_COMPASS_THRESHOLD_OPTION_SMALLER = '<'
  • BRICKLET_COMPASS_THRESHOLD_OPTION_GREATER = '>'
procedure TBrickletCompass.SetMagneticFluxDensityCallbackConfiguration(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 OnMagneticFluxDensity 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 TBrickletCompass.GetMagneticFluxDensityCallbackConfiguration(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 SetMagneticFluxDensityCallbackConfiguration 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: TBrickletCompass; const param: word);
begin
  WriteLn(param);
end;

compass.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 TBrickletCompass.OnHeading
procedure(sender: TBrickletCompass; const heading: smallint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletCompass
  • heading – Typ: smallint, Wertebereich: [-215 bis 215 - 1]

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

Der Parameter ist der gleiche wie GetHeading.

property TBrickletCompass.OnMagneticFluxDensity
procedure(sender: TBrickletCompass; const x: longint; const y: longint; const z: longint) of object;
Callback-Parameter:
  • sender – Typ: TBrickletCompass
  • x – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • y – Typ: longint, Wertebereich: [-231 bis 231 - 1]
  • z – Typ: longint, Wertebereich: [-231 bis 231 - 1]

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

Die Parameter sind der gleichen wie GetMagneticFluxDensity.

Konstanten

const BRICKLET_COMPASS_DEVICE_IDENTIFIER

Diese Konstante wird verwendet um ein Compass 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_COMPASS_DEVICE_DISPLAY_NAME

Diese Konstante stellt den Anzeigenamen eines Compass Bricklet dar.