Software / API Bindings / Delphi/Lazarus / API Reference and Examples / Bricklets / Outdoor Weather Bricklet

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)

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]));

  if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_N) then begin
    WriteLn('Wind Direction (Station): N');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NNE) then begin
    WriteLn('Wind Direction (Station): NNE');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NE) then begin
    WriteLn('Wind Direction (Station): NE');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_ENE) then begin
    WriteLn('Wind Direction (Station): ENE');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_E) then begin
    WriteLn('Wind Direction (Station): E');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_ESE) then begin
    WriteLn('Wind Direction (Station): ESE');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SE) then begin
    WriteLn('Wind Direction (Station): SE');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SSE) then begin
    WriteLn('Wind Direction (Station): SSE');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_S) then begin
    WriteLn('Wind Direction (Station): S');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SSW) then begin
    WriteLn('Wind Direction (Station): SSW');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_SW) then begin
    WriteLn('Wind Direction (Station): SW');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_WSW) then begin
    WriteLn('Wind Direction (Station): WSW');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_W) then begin
    WriteLn('Wind Direction (Station): W');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_WNW) then begin
    WriteLn('Wind Direction (Station): WNW');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NW) then begin
    WriteLn('Wind Direction (Station): NW');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_NNW) then begin
    WriteLn('Wind Direction (Station): NNW');
  end
  else if (windDirection = BRICKLET_OUTDOOR_WEATHER_WIND_DIRECTION_ERROR) then begin
    WriteLn('Wind Direction (Station): Error');
  end;

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

Parameters:	uid – Type: string ipcon – Type: TIPConnection
Returns:	outdoorWeather – Type: TBrickletOutdoorWeather

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.

function TBrickletOutdoorWeather.GetStationIdentifiers: array of byte¶

Returns:	identifiers – Type: array of byte, Range: [0 to 255]

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.

Since firmware version 2.0.2 a station is removed from the list if no data was received for 12 hours.

function TBrickletOutdoorWeather.GetSensorIdentifiers: array of byte¶

Returns:	identifiers – Type: array of byte, Range: [0 to 255]

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.

Since firmware version 2.0.2 a sensor is removed from the list if no data was received for 12 hours.

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

Parameters:

identifier – Type: byte, Range: [0 to 255]

Output Parameters:

temperature – Type: smallint, Unit: 1/10 °C, Range: [-400 to 650]
humidity – Type: byte, Unit: 1 %, Range: [10 to 99]
windSpeed – Type: longword, Unit: 1/10 m/s, Range: [0 to 2³² - 1]
gustSpeed – Type: longword, Unit: 1/10 m/s, Range: [0 to 2³² - 1]
rain – Type: longword, Unit: 1/10 mm, Range: [0 to 2³² - 1]
windDirection – Type: byte, Range: See constants
batteryLow – Type: boolean
lastChange – Type: word, Unit: 1 s, Range: [0 to 2¹⁶ - 1]

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,
Humidity,
Wind Speed,
Gust Speed,
Rain Fall (accumulated since station power-up),
Wind Direction,
Battery Low (true if battery is low) and
Last Change (seconds since the reception of this data).

The following constants are available for this function:

For 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)¶

Parameters:	identifier – Type: byte, Range: [0 to 255]
Output Parameters:	temperature – Type: smallint, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1] humidity – Type: byte, Unit: 1 %, Range: [0 to 255] lastChange – Type: word, Unit: 1 s, Range: [0 to 2¹⁶ - 1]

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,
Humidity and
Last Change (seconds since the last reception of data).

Advanced Functions¶

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

Output Parameters:	errorCountAckChecksum – Type: longword, Range: [0 to 2³² - 1] errorCountMessageChecksum – Type: longword, Range: [0 to 2³² - 1] errorCountFrame – Type: longword, Range: [0 to 2³² - 1] errorCountOverflow – Type: longword, Range: [0 to 2³² - 1]

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.

procedure TBrickletOutdoorWeather.SetStatusLEDConfig(const config: byte)¶

Parameters:	config – Type: byte, Range: See constants, Default: 3

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:

For 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¶

Returns:	config – Type: byte, Range: See constants, Default: 3

Returns the configuration as set by SetStatusLEDConfig

The following constants are available for this function:

For 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¶

Returns:	temperature – Type: smallint, Unit: 1 °C, Range: [-2¹⁵ to 2¹⁵ - 1]

Returns the temperature 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.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)¶

Output Parameters:

Output Parameters:	uid – Type: string, Length: up to 8 connectedUid – Type: string, Length: up to 8 position – Type: char, Range: ['a' to 'h', 'z'] hardwareVersion – Type: array [0..2] of byte 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] firmwareVersion – Type: array [0..2] of byte 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255] deviceIdentifier – Type: word, Range: [0 to 2¹⁶ - 1]

uid – Type: string, Length: up to 8
connectedUid – Type: string, Length: up to 8
position – Type: char, Range: ['a' to 'h', 'z']
hardwareVersion – Type: array [0..2] of byte

0: major – Type: byte, Range: [0 to 255]
1: minor – Type: byte, Range: [0 to 255]
2: revision – Type: byte, Range: [0 to 255]

firmwareVersion – Type: array [0..2] of byte

0: major – Type: byte, Range: [0 to 255]
1: minor – Type: byte, Range: [0 to 255]
2: revision – Type: byte, Range: [0 to 255]

deviceIdentifier – Type: word, Range: [0 to 2¹⁶ - 1]

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', 'd', 'e', 'f', 'g' or 'h' (Bricklet Port). A Bricklet connected to an Isolator Bricklet is always at position 'z'.

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

Parameters:	enableCallback – Type: boolean, Default: false

Turns callback for station data on or off.

function TBrickletOutdoorWeather.GetStationCallbackConfiguration: boolean¶

Returns:	enableCallback – Type: boolean, Default: false

Returns the configuration as set by SetStationCallbackConfiguration.

procedure TBrickletOutdoorWeather.SetSensorCallbackConfiguration(const enableCallback: boolean)¶

Parameters:	enableCallback – Type: boolean, Default: false

Turns callback for sensor data on or off.

function TBrickletOutdoorWeather.GetSensorCallbackConfiguration: boolean¶

Returns:	enableCallback – Type: boolean, Default: false

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 value: longint);
begin
  WriteLn(Format('Value: %d', [value]));
end;

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

The available callback properties and their parameter types 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;

Callback Parameters:

Callback Parameters:	sender – Type: TBrickletOutdoorWeather identifier – Type: byte, Range: [0 to 255] temperature – Type: smallint, Unit: 1/10 °C, Range: [-400 to 650] humidity – Type: byte, Unit: 1 %, Range: [10 to 99] windSpeed – Type: longword, Unit: 1/10 m/s, Range: [0 to 2³² - 1] gustSpeed – Type: longword, Unit: 1/10 m/s, Range: [0 to 2³² - 1] rain – Type: longword, Unit: 1/10 mm, Range: [0 to 2³² - 1] windDirection – Type: byte, Range: See constants batteryLow – Type: boolean

sender – Type: TBrickletOutdoorWeather
identifier – Type: byte, Range: [0 to 255]
temperature – Type: smallint, Unit: 1/10 °C, Range: [-400 to 650]
humidity – Type: byte, Unit: 1 %, Range: [10 to 99]
windSpeed – Type: longword, Unit: 1/10 m/s, Range: [0 to 2³² - 1]
gustSpeed – Type: longword, Unit: 1/10 m/s, Range: [0 to 2³² - 1]
rain – Type: longword, Unit: 1/10 mm, Range: [0 to 2³² - 1]
windDirection – Type: byte, Range: See constants
batteryLow – Type: boolean

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:

For 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 Parameters:	sender – Type: TBrickletOutdoorWeather identifier – Type: byte, Range: [0 to 255] temperature – Type: smallint, Unit: 1/10 °C, Range: [-2¹⁵ to 2¹⁵ - 1] humidity – Type: byte, Unit: 1 %, Range: [0 to 255]

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

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

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

Virtual Functions¶

Virtual functions don't communicate with the device itself, but operate only on the API bindings device object. They can be called without the corresponding IP Connection object being connected.

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

Output Parameters:	apiVersion – Type: array [0..2] of byte 0: major – Type: byte, Range: [0 to 255] 1: minor – Type: byte, Range: [0 to 255] 2: revision – Type: byte, Range: [0 to 255]

Returns the version of the API definition 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¶

Parameters:	functionId – Type: byte, Range: See constants
Returns:	responseExpected – Type: 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 sent and errors are silently ignored, because they cannot be detected.

The following constants are available for this function:

For 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)¶

Parameters:	functionId – Type: byte, Range: See constants responseExpected – Type: 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.

The following constants are available for this function:

For 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)¶

Parameters:	responseExpected – Type: boolean

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

Internal Functions¶

Internal functions are used for maintenance tasks such as flashing a new firmware of changing the UID of a Bricklet. These task should be performed using Brick Viewer instead of using the internal functions directly.

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

Parameters:	mode – Type: byte, Range: See constants
Returns:	status – Type: byte, Range: See constants

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:

For 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

For 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¶

Returns:	mode – Type: byte, Range: See constants

Returns the current bootloader mode, see SetBootloaderMode.

The following constants are available for this function:

For 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)¶

Parameters:	pointer – Type: longword, Unit: 1 B, Range: [0 to 2³² - 1]

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¶

Parameters:	data – Type: array [0..63] of byte, Range: [0 to 255]
Returns:	status – Type: byte, Range: [0 to 255]

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.WriteUID(const uid: longword)¶

Parameters:	uid – Type: longword, Range: [0 to 2³² - 1]

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:	uid – Type: longword, Range: [0 to 2³² - 1]

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

Constants¶

const BRICKLET_OUTDOOR_WEATHER_DEVICE_IDENTIFIER¶

This constant is used to identify a Outdoor Weather Bricklet.

The GetIdentity function and the TIPConnection.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.