Delphi/Lazarus - Outdoor Weather Bricklet

This is the description of the Delphi/Lazarus API bindings for the Outdoor Weather Bricklet. General information and technical specifications for the Outdoor Weather Bricklet are summarized in its hardware description.

An installation guide for the Delphi/Lazarus API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
program ExampleCallback;

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

uses
  SysUtils, IPConnection, BrickletOutdoorWeather;

type
  TExample = class
  private
    ipcon: TIPConnection;
    ow: TBrickletOutdoorWeather;
  public
    procedure StationDataCB(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);
    procedure SensorDataCB(sender: TBrickletOutdoorWeather; const identifier: byte;
                           const temperature: smallint; const humidity: byte);
    procedure Execute;
  end;

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

var
  e: TExample;

{ Callback procedure for station data callback }
procedure TExample.StationDataCB(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);
begin
  WriteLn(Format('Identifier (Station): %d', [identifier]));
  WriteLn(Format('Temperature (Station): %f °C', [temperature/10.0]));
  WriteLn(Format('Humidity (Station): %d %%RH', [humidity]));
  WriteLn(Format('Wind Speed (Station): %f m/s', [windSpeed/10.0]));
  WriteLn(Format('Gust Speed (Station): %f m/s', [gustSpeed/10.0]));
  WriteLn(Format('Rain (Station): %f mm', [rain/10.0]));
  WriteLn(Format('Wind Direction (Station): %d', [windDirection]));
  WriteLn(Format('Battery Low (Station): %d', [batteryLow]));
  WriteLn('');
end;

{ Callback procedure for sensor data callback }
procedure TExample.SensorDataCB(sender: TBrickletOutdoorWeather; const identifier: byte;
                                const temperature: smallint; const humidity: byte);
begin
  WriteLn(Format('Identifier (Sensor): %d', [identifier]));
  WriteLn(Format('Temperature (Sensor): %f °C', [temperature/10.0]));
  WriteLn(Format('Humidity (Sensor): %d %%RH', [humidity]));
  WriteLn('');
end;

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

  { Create device object }
  ow := TBrickletOutdoorWeather.Create(UID, ipcon);

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

  { Enable station data callbacks }
  ow.SetStationCallbackConfiguration(true);

  { Enable sensor data callbacks }
  ow.SetSensorCallbackConfiguration(true);

  { Register station data callback to procedure StationDataCB }
  ow.OnStationData := {$ifdef FPC}@{$endif}StationDataCB;

  { Register sensor data callback to procedure SensorDataCB }
  ow.OnSensorData := {$ifdef FPC}@{$endif}SensorDataCB;

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

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

API

Since Delphi does not support multiple return values directly, we use the out keyword to return multiple values from a function.

All functions and procedures listed below are thread-safe.

Basic Functions

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

Creates an object with the unique device ID uid:

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

This object can then be used after the IP Connection is connected (see examples above).

procedure TBrickletOutdoorWeather.GetStationIdentifiersLowLevel(out identifiersLength: word; out identifiersChunkOffset: word; out identifiersChunkData: array [0..59] of byte)

Returns the identifiers (number between 0 and 255) of all stations that have been seen since the startup of the Bricklet.

Each station gives itself a random identifier on first startup.

procedure TBrickletOutdoorWeather.GetSensorIdentifiersLowLevel(out identifiersLength: word; out identifiersChunkOffset: word; out identifiersChunkData: array [0..59] of byte)

Returns the identifiers (number between 0 and 255) of all sensors that have been seen since the startup of the Bricklet.

Each sensor gives itself a random identifier on first startup.

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)

Returns the last received data for a station with the given identifier. Call GetStationIdentifiers for a list of all available identifiers.

The return values are:

  • Temperature in °C/10,
  • Humidity in %RH,
  • Wind Speed in m/10s,
  • Gust Speed in m/10s,
  • Rain Fall in mm/10,
  • Wind Direction (N, NNE, NE, ENE, E, ESE, SE, SSE, S, SSW, SW, WSW, W, WNW, NW, NNW),
  • Battery Low (true or false) and
  • Last Change (time in seconds since the reception of this data).

The following constants are available for this function:

  • 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)

Returns the last measured data for a sensor with the given identifier. Call GetSensorIdentifiers for a list of all available identifiers.

The return values are:

  • Temperature in °C/10,
  • Humidity in %RH and
  • Last Change (time in seconds since the last reception of data).

Advanced Functions

function TBrickletOutdoorWeather.GetAPIVersion: array [0..2] of byte

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

function TBrickletOutdoorWeather.GetResponseExpected(const functionId: byte): boolean

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by SetResponseExpected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See SetResponseExpected for the list of function ID constants available for this function.

procedure TBrickletOutdoorWeather.SetResponseExpected(const functionId: byte; const responseExpected: boolean)

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • 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)

Changes the response expected flag for all setter and callback configuration functions of this device at once.

procedure TBrickletOutdoorWeather.GetSPITFPErrorCount(out errorCountAckChecksum: longword; out errorCountMessageChecksum: longword; out errorCountFrame: longword; out errorCountOverflow: longword)

Returns the error count for the communication between Brick and Bricklet.

The errors are divided into

  • ACK checksum errors,
  • message checksum errors,
  • framing errors and
  • overflow errors.

The errors counts are for errors that occur on the Bricklet side. All Bricks have a similar function that returns the errors on the Brick side.

function TBrickletOutdoorWeather.SetBootloaderMode(const mode: byte): byte

Sets the bootloader mode and returns the status after the requested mode change was instigated.

You can change from bootloader mode to firmware mode and vice versa. A change from bootloader mode to firmware mode will only take place if the entry function, device identifier and CRC are present and correct.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

The following constants are available for this function:

  • 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
  • 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

Returns the current bootloader mode, see SetBootloaderMode.

The following constants are available for this function:

  • 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)

Sets the firmware pointer for WriteFirmware. The pointer has to be increased by chunks of size 64. The data is written to flash every 4 chunks (which equals to one page of size 256).

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

function TBrickletOutdoorWeather.WriteFirmware(const data: array [0..63] of byte): byte

Writes 64 Bytes of firmware at the position as written by SetWriteFirmwarePointer before. The firmware is written to flash every 4 chunks.

You can only write firmware in bootloader mode.

This function is used by Brick Viewer during flashing. It should not be necessary to call it in a normal user program.

procedure TBrickletOutdoorWeather.SetStatusLEDConfig(const config: byte)

Sets the status LED configuration. By default the LED shows communication traffic between Brick and Bricklet, it flickers once for every 10 received data packets.

You can also turn the LED permanently on/off or show a heartbeat.

If the Bricklet is in bootloader mode, the LED is will show heartbeat by default.

The following constants are available for this function:

  • 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

Returns the configuration as set by SetStatusLEDConfig

The following constants are available for this function:

  • 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

Returns the temperature in °C as measured inside the microcontroller. The value returned is not the ambient temperature!

The temperature is only proportional to the real temperature and it has bad accuracy. Practically it is only useful as an indicator for temperature changes.

procedure TBrickletOutdoorWeather.Reset

Calling this function will reset the Bricklet. All configurations will be lost.

After a reset you have to create new device objects, calling functions on the existing ones will result in undefined behavior!

procedure TBrickletOutdoorWeather.WriteUID(const uid: longword)

Writes a new UID into flash. If you want to set a new UID you have to decode the Base58 encoded UID string into an integer first.

We recommend that you use Brick Viewer to change the UID.

function TBrickletOutdoorWeather.ReadUID: longword

Returns the current UID as an integer. Encode as Base58 to get the usual string version.

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)

Returns the UID, the UID where the Bricklet is connected to, the position, the hardware and firmware version as well as the device identifier.

The position can be 'a', 'b', 'c' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

Callback Configuration Functions

procedure TBrickletOutdoorWeather.SetStationCallbackConfiguration(const enableCallback: boolean)

Turns callback for station data on or off. Default is off.

function TBrickletOutdoorWeather.GetStationCallbackConfiguration: boolean

Returns the configuration as set by SetStationCallbackConfiguration.

procedure TBrickletOutdoorWeather.SetSensorCallbackConfiguration(const enableCallback: boolean)

Turns callback for sensor data on or off. Default is off.

function TBrickletOutdoorWeather.GetSensorCallbackConfiguration: boolean

Returns the configuration as set by SetSensorCallbackConfiguration.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done by assigning a procedure to an callback property of the device object:

procedure TExample.MyCallback(sender: TBrickletOutdoorWeather; const param: word);
begin
  WriteLn(param);
end;

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

The available callback property and their type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

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;

Reports the station data every time a new data packet is received. See GetStationData for information about the data.

For each station the callback will be triggered about every 45 seconds.

Turn the callback on/off with SetStationCallbackConfiguration (by default it is turned off).

The following constants are available for this function:

  • 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;

Reports the sensor data every time a new data packet is received. See GetSensorData for information about the data.

For each station the callback will be called about every 45 seconds.

Turn the callback on/off with SetSensorCallbackConfiguration (by default it is turned off).

Constants

const BRICKLET_OUTDOOR_WEATHER_DEVICE_IDENTIFIER

This constant is used to identify a Outdoor Weather Bricklet.

The GetIdentity function and the OnEnumerate callback of the IP Connection have a deviceIdentifier parameter to specify the Brick's or Bricklet's type.

const BRICKLET_OUTDOOR_WEATHER_DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Outdoor Weather Bricklet.