Delphi/Lazarus - Outdoor Weather Bricklet¶

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, BrickletOutdoorWeather;
  8
  9type
 10  TExample = class
 11  private
 12    ipcon: TIPConnection;
 13    ow: TBrickletOutdoorWeather;
 14  public
 15    procedure StationDataCB(sender: TBrickletOutdoorWeather; const identifier: byte;
 16                            const temperature: smallint; const humidity: byte;
 17                            const windSpeed: longword; const gustSpeed: longword;
 18                            const rain: longword; const windDirection: byte;
 19                            const batteryLow: boolean);
 20    procedure SensorDataCB(sender: TBrickletOutdoorWeather; const identifier: byte;
 21                           const temperature: smallint; const humidity: byte);
 22    procedure Execute;
 23  end;
 24
 25const
 26  HOST = 'localhost';
 27  PORT = 4223;
 28  UID = 'XYZ'; { Change XYZ to the UID of your Outdoor Weather Bricklet }
 29
 30var
 31  e: TExample;
 32
 33{ Callback procedure for station data callback }
 34procedure TExample.StationDataCB(sender: TBrickletOutdoorWeather; const identifier: byte;
 35                                 const temperature: smallint; const humidity: byte;
 36                                 const windSpeed: longword; const gustSpeed: longword;
 37                                 const rain: longword; const windDirection: byte;
 38                                 const batteryLow: boolean);
 39begin
 40  WriteLn(Format('Identifier (Station): %d', [identifier]));
 41  WriteLn(Format('Temperature (Station): %f °C', [temperature/10.0]));
 42  WriteLn(Format('Humidity (Station): %d %%RH', [humidity]));
 43  WriteLn(Format('Wind Speed (Station): %f m/s', [windSpeed/10.0]));
 44  WriteLn(Format('Gust Speed (Station): %f m/s', [gustSpeed/10.0]));
 45  WriteLn(Format('Rain (Station): %f mm', [rain/10.0]));
 46
 47  if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_N) then begin
 48    WriteLn('Wind Direction (Station): N');
 49  end
 50  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NNE) then begin
 51    WriteLn('Wind Direction (Station): NNE');
 52  end
 53  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NE) then begin
 54    WriteLn('Wind Direction (Station): NE');
 55  end
 56  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_ENE) then begin
 57    WriteLn('Wind Direction (Station): ENE');
 58  end
 59  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_E) then begin
 60    WriteLn('Wind Direction (Station): E');
 61  end
 62  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_ESE) then begin
 63    WriteLn('Wind Direction (Station): ESE');
 64  end
 65  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SE) then begin
 66    WriteLn('Wind Direction (Station): SE');
 67  end
 68  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SSE) then begin
 69    WriteLn('Wind Direction (Station): SSE');
 70  end
 71  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_S) then begin
 72    WriteLn('Wind Direction (Station): S');
 73  end
 74  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SSW) then begin
 75    WriteLn('Wind Direction (Station): SSW');
 76  end
 77  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SW) then begin
 78    WriteLn('Wind Direction (Station): SW');
 79  end
 80  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_WSW) then begin
 81    WriteLn('Wind Direction (Station): WSW');
 82  end
 83  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_W) then begin
 84    WriteLn('Wind Direction (Station): W');
 85  end
 86  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_WNW) then begin
 87    WriteLn('Wind Direction (Station): WNW');
 88  end
 89  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NW) then begin
 90    WriteLn('Wind Direction (Station): NW');
 91  end
 92  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NNW) then begin
 93    WriteLn('Wind Direction (Station): NNW');
 94  end
 95  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_ERROR) then begin
 96    WriteLn('Wind Direction (Station): Error');
 97  end;
 98
 99  WriteLn(Format('Battery Low (Station): %d', [batteryLow]));
100  WriteLn('');
101end;
102
103{ Callback procedure for sensor data callback }
104procedure TExample.SensorDataCB(sender: TBrickletOutdoorWeather; const identifier: byte;
105                                const temperature: smallint; const humidity: byte);
106begin
107  WriteLn(Format('Identifier (Sensor): %d', [identifier]));
108  WriteLn(Format('Temperature (Sensor): %f °C', [temperature/10.0]));
109  WriteLn(Format('Humidity (Sensor): %d %%RH', [humidity]));
110  WriteLn('');
111end;
112
113procedure TExample.Execute;
114begin
115  { Create IP connection }
116  ipcon := TIPConnection.Create;
117
118  { Create device object }
119  ow := TBrickletOutdoorWeather.Create(UID, ipcon);
120
121  { Connect to brickd }
122  ipcon.Connect(HOST, PORT);
123  { Don't use device before ipcon is connected }
124
125  { Enable station data callbacks }
126  ow.SetStationCallbackConfiguration(true);
127
128  { Enable sensor data callbacks }
129  ow.SetSensorCallbackConfiguration(true);
130
131  { Register station data callback to procedure StationDataCB }
132  ow.OnStationData := {$ifdef FPC}@{$endif}StationDataCB;
133
134  { Register sensor data callback to procedure SensorDataCB }
135  ow.OnSensorData := {$ifdef FPC}@{$endif}SensorDataCB;
136
137  WriteLn('Press key to exit');
138  ReadLn;
139  ipcon.Destroy; { Calls ipcon.Disconnect internally }
140end;
141
142begin
143  e := TExample.Create;
144  e.Execute;
145  e.Destroy;
146end.

Grundfunktionen¶

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

Parameter:	uid – Typ: string ipcon – Typ: TIPConnection
Rückgabe:	outdoorWeather – Typ: TBrickletOutdoorWeather

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

outdoorWeather := TBrickletOutdoorWeather.Create('YOUR_DEVICE_UID', ipcon);

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

function TBrickletOutdoorWeather.GetStationIdentifiers: array of byte¶

Rückgabe:	identifiers – Typ: array of byte, Wertebereich: [0 bis 255]

Gibt die Identifier (Zahl zwischen 0 und 255) von allen 'Stationen <https://www.tinkerforge.com/de/shop/accessories/sensors/outdoor-weather-station-ws-6147.html>`__ die seit dem Start des Bricklets entdeckt wurden.

Jede Station gibt sich selbst einen zufälligen Identifier beim ersten Start.

Seit Firmware-Version 2.0.2 wird eine Station von der Liste wieder entfernt wenn für 12 Stunden am Stück keine Daten empfangen werden.

function TBrickletOutdoorWeather.GetSensorIdentifiers: array of byte¶

Rückgabe:	identifiers – Typ: array of byte, Wertebereich: [0 bis 255]

Gibt die Identifier (Zahl zwischen 0 und 255) von allen 'Sensoren <https://www.tinkerforge.com/en/shop/accessories/sensors/temperature-humidity-sensor-th-6148.html>`__ die seit dem Start des Bricklets entdeckt wurden.

Jede Sensor gibt sich selbst einen zufälligen Identifier beim ersten Start.

Seit Firmware-Version 2.0.2 wird ein Sensor von der Liste wieder entfernt wenn für 12 Stunden am Stück keine Daten empfangen werden.

procedure TBrickletOutdoorWeather.GetStationData(const identifier: byte; out temperature: smallint; out humidity: byte; out windSpeed: longword; out gustSpeed: longword; out rain: longword; out windDirection: byte; out batteryLow: boolean; out lastChange: word)¶

Parameter:

identifier – Typ: byte, Wertebereich: [0 bis 255]

Ausgabeparameter:

temperature – Typ: smallint, Einheit: 1/10 °C, Wertebereich: [-400 bis 650] humidity – Typ: byte, Einheit: 1 %, Wertebereich: [10 bis 99] windSpeed – Typ: longword, Einheit: 1/10 m/s, Wertebereich: [0 bis 232 - 1] gustSpeed – Typ: longword, Einheit: 1/10 m/s, Wertebereich: [0 bis 232 - 1] rain – Typ: longword, Einheit: 1/10 mm, Wertebereich: [0 bis 232 - 1] windDirection – Typ: byte, Wertebereich: Siehe Konstanten batteryLow – Typ: boolean lastChange – Typ: word, Einheit: 1 s, Wertebereich: [0 bis 216 - 1]

Gibt die zuletzt empfangenen Daten für die Station mit dem entsprechenden Identifier zurück.

Die Rückgabewerte sind:

• Temperatur,

• Luftfeuchte,

• Windgeschwindigkeit,

• Windböengeschwindigkeit,

• Niederschlag (kumuliert seit dem Einschalten der Station),

• Windrichtung,

• Batteriewarnung (true wenn der Batteriestand niedrig ist) und

• Letzte Änderung (Sekunden seitdem diese Daten empfangen wurden).

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

Für windDirection:

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_N = 0

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NNE = 1

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NE = 2

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_ENE = 3

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_E = 4

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_ESE = 5

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SE = 6

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SSE = 7

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_S = 8

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SSW = 9

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SW = 10

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_WSW = 11

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_W = 12

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_WNW = 13

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NW = 14

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NNW = 15

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_ERROR = 255

procedure TBrickletOutdoorWeather.GetSensorData(const identifier: byte; out temperature: smallint; out humidity: byte; out lastChange: word)¶

Parameter:	identifier – Typ: byte, Wertebereich: [0 bis 255]
Ausgabeparameter:	temperature – Typ: smallint, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1] humidity – Typ: byte, Einheit: 1 %, Wertebereich: [0 bis 255] lastChange – Typ: word, Einheit: 1 s, Wertebereich: [0 bis 216 - 1]

Gibt die zuletzt empfangenen Daten für den Sensor mit dem entsprechenden Identifier zurück.

Die Rückgabewerte sind:

• Temperatur,

• Luftfeuchte und

• Letzte Änderung (Sekunden seitdem diese Daten empfangen wurden).

Fortgeschrittene Funktionen¶

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

procedure TBrickletOutdoorWeather.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_OUTDOOR_WEATHER_STATUS_LED_CONFIG_OFF = 0

• BRICKLET_OUTDOOR_WEATHER_STATUS_LED_CONFIG_ON = 1

• BRICKLET_OUTDOOR_WEATHER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

• BRICKLET_OUTDOOR_WEATHER_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletOutdoorWeather.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_OUTDOOR_WEATHER_STATUS_LED_CONFIG_OFF = 0

• BRICKLET_OUTDOOR_WEATHER_STATUS_LED_CONFIG_ON = 1

• BRICKLET_OUTDOOR_WEATHER_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2

• BRICKLET_OUTDOOR_WEATHER_STATUS_LED_CONFIG_SHOW_STATUS = 3

function TBrickletOutdoorWeather.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 TBrickletOutdoorWeather.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 TBrickletOutdoorWeather.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 TBrickletOutdoorWeather.SetStationCallbackConfiguration(const enableCallback: boolean)¶

Parameter:	enableCallback – Typ: boolean, Standardwert: false

Aktiviert/Deaktiviert den Callback für Stationsdaten.

function TBrickletOutdoorWeather.GetStationCallbackConfiguration: boolean¶

Rückgabe:	enableCallback – Typ: boolean, Standardwert: false

Gibt die Konfiguration zurück wie von SetStationCallbackConfiguration gesetzt.

procedure TBrickletOutdoorWeather.SetSensorCallbackConfiguration(const enableCallback: boolean)¶

Parameter:	enableCallback – Typ: boolean, Standardwert: false

Aktiviert/Deaktiviert den Callback für Sensordaten.

function TBrickletOutdoorWeather.GetSensorCallbackConfiguration: boolean¶

Rückgabe:	enableCallback – Typ: boolean, Standardwert: false

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

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

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

property TBrickletOutdoorWeather.OnStationData¶

procedure(sender: TBrickletOutdoorWeather; const identifier: byte; const temperature: smallint; const humidity: byte; const windSpeed: longword; const gustSpeed: longword; const rain: longword; const windDirection: byte; const batteryLow: boolean) of object;

Callback-Parameter:

sender – Typ: TBrickletOutdoorWeather identifier – Typ: byte, Wertebereich: [0 bis 255] temperature – Typ: smallint, Einheit: 1/10 °C, Wertebereich: [-400 bis 650] humidity – Typ: byte, Einheit: 1 %, Wertebereich: [10 bis 99] windSpeed – Typ: longword, Einheit: 1/10 m/s, Wertebereich: [0 bis 232 - 1] gustSpeed – Typ: longword, Einheit: 1/10 m/s, Wertebereich: [0 bis 232 - 1] rain – Typ: longword, Einheit: 1/10 mm, Wertebereich: [0 bis 232 - 1] windDirection – Typ: byte, Wertebereich: Siehe Konstanten batteryLow – Typ: boolean

Meldet die Stationsdaten bei jedem eingehenden Datenpaket. Siehe GetStationData für Details über die Daten.

Für jede Station wird dieser Callback ca. alle 45 Sekunden ausgelöst werden.

Der Callback kann mittels SetStationCallbackConfiguration aktiviert/deaktiviert werden (standardmäßig ist der Callback deaktiviert).

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

Für windDirection:

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_N = 0

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NNE = 1

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NE = 2

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_ENE = 3

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_E = 4

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_ESE = 5

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SE = 6

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SSE = 7

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_S = 8

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SSW = 9

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SW = 10

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_WSW = 11

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_W = 12

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_WNW = 13

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NW = 14

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NNW = 15

• BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_ERROR = 255

property TBrickletOutdoorWeather.OnSensorData¶

procedure(sender: TBrickletOutdoorWeather; const identifier: byte; const temperature: smallint; const humidity: byte) of object;

Callback-Parameter:	sender – Typ: TBrickletOutdoorWeather identifier – Typ: byte, Wertebereich: [0 bis 255] temperature – Typ: smallint, Einheit: 1/10 °C, Wertebereich: [-215 bis 215 - 1] humidity – Typ: byte, Einheit: 1 %, Wertebereich: [0 bis 255]

Meldet die Sensordaten bei jedem eingehenden Datenpaket. Siehe GetSensorData für Details über die Daten.

Für jeden Sensor wird dieser Callback ca. alle 45 Sekunden ausgelöst werden.

Der Callback kann mittels SetSensorCallbackConfiguration aktiviert/deaktiviert werden (standardmäßig ist der Callback deaktiviert).

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 TBrickletOutdoorWeather.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 TBrickletOutdoorWeather.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_OUTDOOR_WEATHER_FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5

• BRICKLET_OUTDOOR_WEATHER_FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7

• BRICKLET_OUTDOOR_WEATHER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

• BRICKLET_OUTDOOR_WEATHER_FUNCTION_SET_STATUS_LED_CONFIG = 239

• BRICKLET_OUTDOOR_WEATHER_FUNCTION_RESET = 243

• BRICKLET_OUTDOOR_WEATHER_FUNCTION_WRITE_UID = 248

procedure TBrickletOutdoorWeather.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_OUTDOOR_WEATHER_FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5

• BRICKLET_OUTDOOR_WEATHER_FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7

• BRICKLET_OUTDOOR_WEATHER_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237

• BRICKLET_OUTDOOR_WEATHER_FUNCTION_SET_STATUS_LED_CONFIG = 239

• BRICKLET_OUTDOOR_WEATHER_FUNCTION_RESET = 243

• BRICKLET_OUTDOOR_WEATHER_FUNCTION_WRITE_UID = 248

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

Interne Funktionen¶

Interne Funktionen werden für Wartungsaufgaben, wie zum Beispiel das Flashen einer neuen Firmware oder das Ändern der UID eines Bricklets, verwendet. Diese Aufgaben sollten mit Brick Viewer durchgeführt werden, anstelle die internen Funktionen direkt zu verwenden.

function TBrickletOutdoorWeather.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_OUTDOOR_WEATHER_BOOTLOADER_MODE_BOOTLOADER = 0

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE = 1

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Für status:

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_STATUS_OK = 0

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_STATUS_INVALID_MODE = 1

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_STATUS_NO_CHANGE = 2

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_STATUS_CRC_MISMATCH = 5

function TBrickletOutdoorWeather.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_OUTDOOR_WEATHER_BOOTLOADER_MODE_BOOTLOADER = 0

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE = 1

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3

• BRICKLET_OUTDOOR_WEATHER_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

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

Konstanten¶

const BRICKLET_OUTDOOR_WEATHER_DEVICE_IDENTIFIER¶

Diese Konstante wird verwendet um ein Outdoor Weather 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_OUTDOOR_WEATHER_DEVICE_DISPLAY_NAME¶

Diese Konstante stellt den Anzeigenamen eines Outdoor Weather Bricklet dar.