Visual Basic .NET - Outdoor Weather Bricklet¶

Callback¶

Download (ExampleCallback.vb)

 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

Imports System
Imports Tinkerforge

Module ExampleCallback
    Const HOST As String = "localhost"
    Const PORT As Integer = 4223
    Const UID As String = "XYZ" ' Change XYZ to the UID of your Outdoor Weather Bricklet

    ' Callback subroutine for station data callback
    Sub StationDataCB(ByVal sender As BrickletOutdoorWeather, ByVal identifier As Byte, _
                      ByVal temperature As Short, ByVal humidity As Byte, _
                      ByVal windSpeed As Long, ByVal gustSpeed As Long, _
                      ByVal rain As Long, ByVal windDirection As Byte, _
                      ByVal batteryLow As Boolean)
        Console.WriteLine("Identifier (Station): " + identifier.ToString())
        Console.WriteLine("Temperature (Station): " + (temperature/10.0).ToString() + " °C")
        Console.WriteLine("Humidity (Station): " + humidity.ToString() + " %RH")
        Console.WriteLine("Wind Speed (Station): " + (windSpeed/10.0).ToString() + " m/s")
        Console.WriteLine("Gust Speed (Station): " + (gustSpeed/10.0).ToString() + " m/s")
        Console.WriteLine("Rain (Station): " + (rain/10.0).ToString() + " mm")

        If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_N Then
            Console.WriteLine("Wind Direction (Station): N")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_NNE Then
            Console.WriteLine("Wind Direction (Station): NNE")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_NE Then
            Console.WriteLine("Wind Direction (Station): NE")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_ENE Then
            Console.WriteLine("Wind Direction (Station): ENE")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_E Then
            Console.WriteLine("Wind Direction (Station): E")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_ESE Then
            Console.WriteLine("Wind Direction (Station): ESE")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_SE Then
            Console.WriteLine("Wind Direction (Station): SE")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_SSE Then
            Console.WriteLine("Wind Direction (Station): SSE")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_S Then
            Console.WriteLine("Wind Direction (Station): S")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_SSW Then
            Console.WriteLine("Wind Direction (Station): SSW")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_SW Then
            Console.WriteLine("Wind Direction (Station): SW")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_WSW Then
            Console.WriteLine("Wind Direction (Station): WSW")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_W Then
            Console.WriteLine("Wind Direction (Station): W")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_WNW Then
            Console.WriteLine("Wind Direction (Station): WNW")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_NW Then
            Console.WriteLine("Wind Direction (Station): NW")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_NNW Then
            Console.WriteLine("Wind Direction (Station): NNW")
        Else If windDirection = BrickletOutdoorWeather.WIND_DIRECTION_ERROR Then
            Console.WriteLine("Wind Direction (Station): Error")
        End If

        Console.WriteLine("Battery Low (Station): " + batteryLow.ToString())
        Console.WriteLine("")
    End Sub

    ' Callback subroutine for sensor data callback
    Sub SensorDataCB(ByVal sender As BrickletOutdoorWeather, ByVal identifier As Byte, _
                     ByVal temperature As Short, ByVal humidity As Byte)
        Console.WriteLine("Identifier (Sensor): " + identifier.ToString())
        Console.WriteLine("Temperature (Sensor): " + (temperature/10.0).ToString() + " °C")
        Console.WriteLine("Humidity (Sensor): " + humidity.ToString() + " %RH")
        Console.WriteLine("")
    End Sub

    Sub Main()
        Dim ipcon As New IPConnection() ' Create IP connection
        Dim ow As New BrickletOutdoorWeather(UID, ipcon) ' Create device object

        ipcon.Connect(HOST, PORT) ' Connect to brickd
        ' 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 subroutine StationDataCB
        AddHandler ow.StationDataCallback, AddressOf StationDataCB

        ' Register sensor data callback to subroutine SensorDataCB
        AddHandler ow.SensorDataCallback, AddressOf SensorDataCB

        Console.WriteLine("Press key to exit")
        Console.ReadLine()
        ipcon.Disconnect()
    End Sub
End Module

Basic Functions¶

Class BrickletOutdoorWeather(ByVal uid As String, ByVal ipcon As IPConnection)¶

Creates an object with the unique device ID uid:

Dim outdoorWeather As New BrickletOutdoorWeather("YOUR_DEVICE_UID", ipcon)

This object can then be used after the IP Connection is connected.

Function BrickletOutdoorWeather.GetStationIdentifiers() As Byte()¶

Returns:	identifiers – Type: Byte Array, Length: variable, 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 BrickletOutdoorWeather.GetSensorIdentifiers() As Byte()¶

Returns:	identifiers – Type: Byte Array, Length: variable, 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.

Sub BrickletOutdoorWeather.GetStationData(ByVal identifier As Byte, ByRef temperature As Short, ByRef humidity As Byte, ByRef windSpeed As Long, ByRef gustSpeed As Long, ByRef rain As Long, ByRef windDirection As Byte, ByRef batteryLow As Boolean, ByRef lastChange As Integer)¶

Parameters:

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

Output Parameters:

temperature – Type: Short, Unit: 1/10 °C, Range: [-400 to 650] humidity – Type: Byte, Unit: 1 %, Range: [10 to 99] windSpeed – Type: Long, Unit: 1/10 m/s, Range: [0 to 232 - 1] gustSpeed – Type: Long, Unit: 1/10 m/s, Range: [0 to 232 - 1] rain – Type: Long, Unit: 1/10 mm, Range: [0 to 232 - 1] windDirection – Type: Byte, Range: See constants batteryLow – Type: Boolean lastChange – Type: Integer, Unit: 1 s, Range: [0 to 216 - 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:

• BrickletOutdoorWeather.WIND_DIRECTION_N = 0
• BrickletOutdoorWeather.WIND_DIRECTION_NNE = 1
• BrickletOutdoorWeather.WIND_DIRECTION_NE = 2
• BrickletOutdoorWeather.WIND_DIRECTION_ENE = 3
• BrickletOutdoorWeather.WIND_DIRECTION_E = 4
• BrickletOutdoorWeather.WIND_DIRECTION_ESE = 5
• BrickletOutdoorWeather.WIND_DIRECTION_SE = 6
• BrickletOutdoorWeather.WIND_DIRECTION_SSE = 7
• BrickletOutdoorWeather.WIND_DIRECTION_S = 8
• BrickletOutdoorWeather.WIND_DIRECTION_SSW = 9
• BrickletOutdoorWeather.WIND_DIRECTION_SW = 10
• BrickletOutdoorWeather.WIND_DIRECTION_WSW = 11
• BrickletOutdoorWeather.WIND_DIRECTION_W = 12
• BrickletOutdoorWeather.WIND_DIRECTION_WNW = 13
• BrickletOutdoorWeather.WIND_DIRECTION_NW = 14
• BrickletOutdoorWeather.WIND_DIRECTION_NNW = 15
• BrickletOutdoorWeather.WIND_DIRECTION_ERROR = 255

Sub BrickletOutdoorWeather.GetSensorData(ByVal identifier As Byte, ByRef temperature As Short, ByRef humidity As Byte, ByRef lastChange As Integer)¶

Parameters:	identifier – Type: Byte, Range: [0 to 255]
Output Parameters:	temperature – Type: Short, Unit: 1/10 °C, Range: [-215 to 215 - 1] humidity – Type: Byte, Unit: 1 %, Range: [0 to 255] lastChange – Type: Integer, Unit: 1 s, Range: [0 to 216 - 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¶

Sub BrickletOutdoorWeather.GetSPITFPErrorCount(ByRef errorCountAckChecksum As Long, ByRef errorCountMessageChecksum As Long, ByRef errorCountFrame As Long, ByRef errorCountOverflow As Long)¶

Output Parameters:	errorCountAckChecksum – Type: Long, Range: [0 to 232 - 1] errorCountMessageChecksum – Type: Long, Range: [0 to 232 - 1] errorCountFrame – Type: Long, Range: [0 to 232 - 1] errorCountOverflow – Type: Long, Range: [0 to 232 - 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.

Sub BrickletOutdoorWeather.SetStatusLEDConfig(ByVal config As 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:

• BrickletOutdoorWeather.STATUS_LED_CONFIG_OFF = 0
• BrickletOutdoorWeather.STATUS_LED_CONFIG_ON = 1
• BrickletOutdoorWeather.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletOutdoorWeather.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletOutdoorWeather.GetStatusLEDConfig() As 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:

• BrickletOutdoorWeather.STATUS_LED_CONFIG_OFF = 0
• BrickletOutdoorWeather.STATUS_LED_CONFIG_ON = 1
• BrickletOutdoorWeather.STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
• BrickletOutdoorWeather.STATUS_LED_CONFIG_SHOW_STATUS = 3

Function BrickletOutdoorWeather.GetChipTemperature() As Short¶

Returns:	temperature – Type: Short, Unit: 1 °C, Range: [-215 to 215 - 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.

Sub BrickletOutdoorWeather.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!

Sub BrickletOutdoorWeather.GetIdentity(ByRef uid As String, ByRef connectedUid As String, ByRef position As Char, ByRef hardwareVersion() As Byte, ByRef firmwareVersion() As Byte, ByRef deviceIdentifier As Integer)¶

Output Parameters:

uid – Type: String, Length: up to 8 connectedUid – Type: String, Length: up to 8 position – Type: Char, Range: ["a"C to "h"C, "z"C] hardwareVersion – Type: Byte Array, Length: 3 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: Byte Array, Length: 3 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: Integer, Range: [0 to 216 - 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¶

Sub BrickletOutdoorWeather.SetStationCallbackConfiguration(ByVal enableCallback As Boolean)¶

Parameters:	enableCallback – Type: Boolean, Default: false

Turns callback for station data on or off.

Function BrickletOutdoorWeather.GetStationCallbackConfiguration() As Boolean¶

Returns:	enableCallback – Type: Boolean, Default: false

Returns the configuration as set by SetStationCallbackConfiguration().

Sub BrickletOutdoorWeather.SetSensorCallbackConfiguration(ByVal enableCallback As Boolean)¶

Parameters:	enableCallback – Type: Boolean, Default: false

Turns callback for sensor data on or off.

Function BrickletOutdoorWeather.GetSensorCallbackConfiguration() As 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:

Sub MyCallback(ByVal sender As BrickletOutdoorWeather, ByVal value As Short)
    Console.WriteLine("Value: {0}", value)
End Sub

AddHandler outdoorWeather.ExampleCallback, AddressOf MyCallback

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

Event BrickletOutdoorWeather.StationDataCallback(ByVal sender As BrickletOutdoorWeather, ByVal identifier As Byte, ByVal temperature As Short, ByVal humidity As Byte, ByVal windSpeed As Long, ByVal gustSpeed As Long, ByVal rain As Long, ByVal windDirection As Byte, ByVal batteryLow As Boolean)¶

Callback Parameters:

sender – Type: BrickletOutdoorWeather identifier – Type: Byte, Range: [0 to 255] temperature – Type: Short, Unit: 1/10 °C, Range: [-400 to 650] humidity – Type: Byte, Unit: 1 %, Range: [10 to 99] windSpeed – Type: Long, Unit: 1/10 m/s, Range: [0 to 232 - 1] gustSpeed – Type: Long, Unit: 1/10 m/s, Range: [0 to 232 - 1] rain – Type: Long, Unit: 1/10 mm, Range: [0 to 232 - 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:

• BrickletOutdoorWeather.WIND_DIRECTION_N = 0
• BrickletOutdoorWeather.WIND_DIRECTION_NNE = 1
• BrickletOutdoorWeather.WIND_DIRECTION_NE = 2
• BrickletOutdoorWeather.WIND_DIRECTION_ENE = 3
• BrickletOutdoorWeather.WIND_DIRECTION_E = 4
• BrickletOutdoorWeather.WIND_DIRECTION_ESE = 5
• BrickletOutdoorWeather.WIND_DIRECTION_SE = 6
• BrickletOutdoorWeather.WIND_DIRECTION_SSE = 7
• BrickletOutdoorWeather.WIND_DIRECTION_S = 8
• BrickletOutdoorWeather.WIND_DIRECTION_SSW = 9
• BrickletOutdoorWeather.WIND_DIRECTION_SW = 10
• BrickletOutdoorWeather.WIND_DIRECTION_WSW = 11
• BrickletOutdoorWeather.WIND_DIRECTION_W = 12
• BrickletOutdoorWeather.WIND_DIRECTION_WNW = 13
• BrickletOutdoorWeather.WIND_DIRECTION_NW = 14
• BrickletOutdoorWeather.WIND_DIRECTION_NNW = 15
• BrickletOutdoorWeather.WIND_DIRECTION_ERROR = 255

Event BrickletOutdoorWeather.SensorDataCallback(ByVal sender As BrickletOutdoorWeather, ByVal identifier As Byte, ByVal temperature As Short, ByVal humidity As Byte)¶

Callback Parameters:	sender – Type: BrickletOutdoorWeather identifier – Type: Byte, Range: [0 to 255] temperature – Type: Short, Unit: 1/10 °C, Range: [-215 to 215 - 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 BrickletOutdoorWeather.GetAPIVersion() As Byte()¶

Output Parameters:	apiVersion – Type: Byte Array, Length: 3 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 BrickletOutdoorWeather.GetResponseExpected(ByVal functionId As Byte) As 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:

• BrickletOutdoorWeather.FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
• BrickletOutdoorWeather.FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
• BrickletOutdoorWeather.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletOutdoorWeather.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletOutdoorWeather.FUNCTION_RESET = 243
• BrickletOutdoorWeather.FUNCTION_WRITE_UID = 248

Sub BrickletOutdoorWeather.SetResponseExpected(ByVal functionId As Byte, ByVal responseExpected As 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.

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:

• BrickletOutdoorWeather.FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
• BrickletOutdoorWeather.FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
• BrickletOutdoorWeather.FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
• BrickletOutdoorWeather.FUNCTION_SET_STATUS_LED_CONFIG = 239
• BrickletOutdoorWeather.FUNCTION_RESET = 243
• BrickletOutdoorWeather.FUNCTION_WRITE_UID = 248

Sub BrickletOutdoorWeather.SetResponseExpectedAll(ByVal responseExpected As 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 BrickletOutdoorWeather.SetBootloaderMode(ByVal mode As Byte) As 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:

• BrickletOutdoorWeather.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletOutdoorWeather.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletOutdoorWeather.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletOutdoorWeather.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletOutdoorWeather.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

For status:

• BrickletOutdoorWeather.BOOTLOADER_STATUS_OK = 0
• BrickletOutdoorWeather.BOOTLOADER_STATUS_INVALID_MODE = 1
• BrickletOutdoorWeather.BOOTLOADER_STATUS_NO_CHANGE = 2
• BrickletOutdoorWeather.BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
• BrickletOutdoorWeather.BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
• BrickletOutdoorWeather.BOOTLOADER_STATUS_CRC_MISMATCH = 5

Function BrickletOutdoorWeather.GetBootloaderMode() As 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:

• BrickletOutdoorWeather.BOOTLOADER_MODE_BOOTLOADER = 0
• BrickletOutdoorWeather.BOOTLOADER_MODE_FIRMWARE = 1
• BrickletOutdoorWeather.BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
• BrickletOutdoorWeather.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
• BrickletOutdoorWeather.BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4

Sub BrickletOutdoorWeather.SetWriteFirmwarePointer(ByVal pointer As Long)¶

Parameters:	pointer – Type: Long, Unit: 1 B, Range: [0 to 232 - 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 BrickletOutdoorWeather.WriteFirmware(ByVal data() As Byte) As Byte¶

Parameters:	data – Type: Byte Array, Length: 64, 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.

Sub BrickletOutdoorWeather.WriteUID(ByVal uid As Long)¶

Parameters:	uid – Type: Long, Range: [0 to 232 - 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 BrickletOutdoorWeather.ReadUID() As Long¶

Returns:	uid – Type: Long, Range: [0 to 232 - 1]

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

Constants¶

Const BrickletOutdoorWeather.DEVICE_IDENTIFIER¶

This constant is used to identify a Outdoor Weather Bricklet.

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

Const BrickletOutdoorWeather.DEVICE_DISPLAY_NAME¶

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