Delphi/Lazarus - Temperature Bricklet¶

Simple¶

Download (ExampleSimple.pas)

 1program ExampleSimple;
 2
 3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
 4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
 5
 6uses
 7  SysUtils, IPConnection, BrickletTemperature;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    t: TBrickletTemperature;
14  public
15    procedure Execute;
16  end;
17
18const
19  HOST = 'localhost';
20  PORT = 4223;
21  UID = 'XYZ'; { Change XYZ to the UID of your Temperature Bricklet }
22
23var
24  e: TExample;
25
26procedure TExample.Execute;
27var temperature: smallint;
28begin
29  { Create IP connection }
30  ipcon := TIPConnection.Create;
31
32  { Create device object }
33  t := TBrickletTemperature.Create(UID, ipcon);
34
35  { Connect to brickd }
36  ipcon.Connect(HOST, PORT);
37  { Don't use device before ipcon is connected }
38
39  { Get current temperature }
40  temperature := t.GetTemperature;
41  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
42
43  WriteLn('Press key to exit');
44  ReadLn;
45  ipcon.Destroy; { Calls ipcon.Disconnect internally }
46end;
47
48begin
49  e := TExample.Create;
50  e.Execute;
51  e.Destroy;
52end.

Callback¶

Download (ExampleCallback.pas)

 1program ExampleCallback;
 2
 3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
 4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
 5
 6uses
 7  SysUtils, IPConnection, BrickletTemperature;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    t: TBrickletTemperature;
14  public
15    procedure TemperatureCB(sender: TBrickletTemperature; const temperature: smallint);
16    procedure Execute;
17  end;
18
19const
20  HOST = 'localhost';
21  PORT = 4223;
22  UID = 'XYZ'; { Change XYZ to the UID of your Temperature Bricklet }
23
24var
25  e: TExample;
26
27{ Callback procedure for temperature callback }
28procedure TExample.TemperatureCB(sender: TBrickletTemperature;
29                                 const temperature: smallint);
30begin
31  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
32end;
33
34procedure TExample.Execute;
35begin
36  { Create IP connection }
37  ipcon := TIPConnection.Create;
38
39  { Create device object }
40  t := TBrickletTemperature.Create(UID, ipcon);
41
42  { Connect to brickd }
43  ipcon.Connect(HOST, PORT);
44  { Don't use device before ipcon is connected }
45
46  { Register temperature callback to procedure TemperatureCB }
47  t.OnTemperature := {$ifdef FPC}@{$endif}TemperatureCB;
48
49  { Set period for temperature callback to 1s (1000ms)
50    Note: The temperature callback is only called every second
51          if the temperature has changed since the last call! }
52  t.SetTemperatureCallbackPeriod(1000);
53
54  WriteLn('Press key to exit');
55  ReadLn;
56  ipcon.Destroy; { Calls ipcon.Disconnect internally }
57end;
58
59begin
60  e := TExample.Create;
61  e.Execute;
62  e.Destroy;
63end.

Threshold¶

Download (ExampleThreshold.pas)

 1program ExampleThreshold;
 2
 3{$ifdef MSWINDOWS}{$apptype CONSOLE}{$endif}
 4{$ifdef FPC}{$mode OBJFPC}{$H+}{$endif}
 5
 6uses
 7  SysUtils, IPConnection, BrickletTemperature;
 8
 9type
10  TExample = class
11  private
12    ipcon: TIPConnection;
13    t: TBrickletTemperature;
14  public
15    procedure TemperatureReachedCB(sender: TBrickletTemperature;
16                                   const temperature: smallint);
17    procedure Execute;
18  end;
19
20const
21  HOST = 'localhost';
22  PORT = 4223;
23  UID = 'XYZ'; { Change XYZ to the UID of your Temperature Bricklet }
24
25var
26  e: TExample;
27
28{ Callback procedure for temperature reached callback }
29procedure TExample.TemperatureReachedCB(sender: TBrickletTemperature;
30                                        const temperature: smallint);
31begin
32  WriteLn(Format('Temperature: %f °C', [temperature/100.0]));
33  WriteLn('It is too hot, we need air conditioning!');
34end;
35
36procedure TExample.Execute;
37begin
38  { Create IP connection }
39  ipcon := TIPConnection.Create;
40
41  { Create device object }
42  t := TBrickletTemperature.Create(UID, ipcon);
43
44  { Connect to brickd }
45  ipcon.Connect(HOST, PORT);
46  { Don't use device before ipcon is connected }
47
48  { Get threshold callbacks with a debounce time of 10 seconds (10000ms) }
49  t.SetDebouncePeriod(10000);
50
51  { Register temperature reached callback to procedure TemperatureReachedCB }
52  t.OnTemperatureReached := {$ifdef FPC}@{$endif}TemperatureReachedCB;
53
54  { Configure threshold for temperature "greater than 30 °C" }
55  t.SetTemperatureCallbackThreshold('>', 30*100, 0);
56
57  WriteLn('Press key to exit');
58  ReadLn;
59  ipcon.Destroy; { Calls ipcon.Disconnect internally }
60end;
61
62begin
63  e := TExample.Create;
64  e.Execute;
65  e.Destroy;
66end.

Grundfunktionen¶

constructor TBrickletTemperature.Create(const uid: string; ipcon: TIPConnection)¶

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	temperature – Typ: TBrickletTemperature

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

temperature := TBrickletTemperature.Create('YOUR_DEVICE_UID', ipcon);

Dieses Objekt kann benutzt werden, nachdem die IP Connection verbunden ist.

function TBrickletTemperature.GetTemperature: smallint¶

Rückgabe:	temperature – Typ: smallint, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

Gibt die Temperatur des Sensors zurück.

Wenn die Temperatur periodisch abgefragt werden soll, wird empfohlen den OnTemperature Callback zu nutzen und die Periode mit SetTemperatureCallbackPeriod vorzugeben.

Fortgeschrittene Funktionen¶

procedure TBrickletTemperature.SetI2CMode(const mode: byte)¶

Parameter:	mode – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Setzt den I2C Modus. Mögliche Modi sind:

• 0: Fast (400kHz)

• 1: Slow (100kHz)

Wenn Probleme mit offensichtlichen Ausreißern in den Temperature Bricklet Messungen auftreten, können diese eventuell aufgrund von elektromagnetischen Störungen sein. In diesem Fall kann es helfen die I2C Geschwindigkeit zu verringern.

Falls in einem System ein hoher Durchsatz an Nachrichten erwünscht ist, sollte die I2C Geschwindigkeit allerdings nicht verringert werden.

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

Für mode:

• BRICKLET_TEMPERATURE_I2C_MODE_FAST = 0

• BRICKLET_TEMPERATURE_I2C_MODE_SLOW = 1

Added in version 2.0.1$nbsp;(Plugin).

function TBrickletTemperature.GetI2CMode: byte¶

Rückgabe:	mode – Typ: byte, Wertebereich: Siehe Konstanten, Standardwert: 0

Gibt den I2C Modus zurück, wie von SetI2CMode gesetzt.

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

Für mode:

• BRICKLET_TEMPERATURE_I2C_MODE_FAST = 0

• BRICKLET_TEMPERATURE_I2C_MODE_SLOW = 1

Added in version 2.0.1$nbsp;(Plugin).

procedure TBrickletTemperature.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', '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 ist 'a', 'b', 'c', 'd', 'e', 'f', 'g' oder 'h' (Bricklet Anschluss). Ein 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 TBrickletTemperature.SetTemperatureCallbackPeriod(const period: longword)¶

Parameter:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Setzt die Periode mit welcher der OnTemperature Callback ausgelöst wird. Ein Wert von 0 deaktiviert den Callback.

Der OnTemperature Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

function TBrickletTemperature.GetTemperatureCallbackPeriod: longword¶

Rückgabe:	period – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 0

Gibt die Periode zurück, wie von SetTemperatureCallbackPeriod gesetzt.

procedure TBrickletTemperature.SetTemperatureCallbackThreshold(const option: char; const min: smallint; const max: smallint)¶

Parameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: smallint, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: smallint, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Setzt den Schwellwert für den OnTemperatureReached Callback.

Die folgenden Optionen sind möglich:

Option	Beschreibung
'x'	Callback ist inaktiv
'o'	Callback wird ausgelöst, wenn die Temperatur außerhalb des min und max Wertes ist
'i'	Callback wird ausgelöst, wenn die Temperatur innerhalb des min und max Wertes ist
'<'	Callback wird ausgelöst, wenn die Temperatur kleiner als der min Wert ist (max wird ignoriert)
'>'	Callback wird ausgelöst, wenn die Temperatur größer als der min Wert ist (max wird ignoriert)

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

Für option:

• BRICKLET_TEMPERATURE_THRESHOLD_OPTION_OFF = 'x'

• BRICKLET_TEMPERATURE_THRESHOLD_OPTION_OUTSIDE = 'o'

• BRICKLET_TEMPERATURE_THRESHOLD_OPTION_INSIDE = 'i'

• BRICKLET_TEMPERATURE_THRESHOLD_OPTION_SMALLER = '<'

• BRICKLET_TEMPERATURE_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletTemperature.GetTemperatureCallbackThreshold(out option: char; out min: smallint; out max: smallint)¶

Ausgabeparameter:	option – Typ: char, Wertebereich: Siehe Konstanten, Standardwert: 'x' min – Typ: smallint, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0 max – Typ: smallint, Einheit: 1/100 °C, Wertebereich: [-215 bis 215 - 1], Standardwert: 0

Gibt den Schwellwert zurück, wie von SetTemperatureCallbackThreshold gesetzt.

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

Für option:

• BRICKLET_TEMPERATURE_THRESHOLD_OPTION_OFF = 'x'

• BRICKLET_TEMPERATURE_THRESHOLD_OPTION_OUTSIDE = 'o'

• BRICKLET_TEMPERATURE_THRESHOLD_OPTION_INSIDE = 'i'

• BRICKLET_TEMPERATURE_THRESHOLD_OPTION_SMALLER = '<'

• BRICKLET_TEMPERATURE_THRESHOLD_OPTION_GREATER = '>'

procedure TBrickletTemperature.SetDebouncePeriod(const debounce: longword)¶

Parameter:	debounce – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Setzt die Periode mit welcher die Schwellwert Callback

• OnTemperatureReached

ausgelöst wird, wenn der Schwellwert

• SetTemperatureCallbackThreshold

weiterhin erreicht bleibt.

function TBrickletTemperature.GetDebouncePeriod: longword¶

Rückgabe:	debounce – Typ: longword, Einheit: 1 ms, Wertebereich: [0 bis 232 - 1], Standardwert: 100

Gibt die Entprellperiode zurück, wie von SetDebouncePeriod 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: TBrickletTemperature; const value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

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

Die verfügbaren Callback Properties und ihre Parametertypen werden weiter unten beschrieben.

property TBrickletTemperature.OnTemperature¶

procedure(sender: TBrickletTemperature; const temperature: smallint) of object;

Callback-Parameter:	sender – Typ: TBrickletTemperature temperature – Typ: smallint, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

Dieser Callback wird mit der Periode, wie gesetzt mit SetTemperatureCallbackPeriod, ausgelöst. Der Parameter ist die Temperatur des Sensors.

Der OnTemperature Callback wird nur ausgelöst, wenn sich die Temperatur seit der letzten Auslösung geändert hat.

property TBrickletTemperature.OnTemperatureReached¶

procedure(sender: TBrickletTemperature; const temperature: smallint) of object;

Callback-Parameter:	sender – Typ: TBrickletTemperature temperature – Typ: smallint, Einheit: 1/100 °C, Wertebereich: [-2500 bis 8500]

Dieser Callback wird ausgelöst, wenn der Schwellwert, wie von SetTemperatureCallbackThreshold gesetzt, erreicht wird. Der Parameter ist die Temperatur des Sensors.

Wenn der Schwellwert erreicht bleibt, wird der Callback mit der Periode, wie mit SetDebouncePeriod gesetzt, ausgelöst.

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 TBrickletTemperature.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 TBrickletTemperature.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_TEMPERATURE_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2

• BRICKLET_TEMPERATURE_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4

• BRICKLET_TEMPERATURE_FUNCTION_SET_DEBOUNCE_PERIOD = 6

• BRICKLET_TEMPERATURE_FUNCTION_SET_I2C_MODE = 10

procedure TBrickletTemperature.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_TEMPERATURE_FUNCTION_SET_TEMPERATURE_CALLBACK_PERIOD = 2

• BRICKLET_TEMPERATURE_FUNCTION_SET_TEMPERATURE_CALLBACK_THRESHOLD = 4

• BRICKLET_TEMPERATURE_FUNCTION_SET_DEBOUNCE_PERIOD = 6

• BRICKLET_TEMPERATURE_FUNCTION_SET_I2C_MODE = 10

procedure TBrickletTemperature.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_TEMPERATURE_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Temperature 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_TEMPERATURE_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Temperature Bricklet dar.