Rust - Outdoor Weather Bricklet

This is the description of the Rust 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 Rust API bindings is part of their general description. Additional documentation can be found on docs.rs.

Examples

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

Callback

Download (example_callback.rs)

 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
95
use std::{error::Error, io, thread};
use tinkerforge::{ip_connection::IpConnection, outdoor_weather_bricklet::*};

const HOST: &str = "localhost";
const PORT: u16 = 4223;
const UID: &str = "XYZ"; // Change XYZ to the UID of your Outdoor Weather Bricklet.

fn main() -> Result<(), Box<dyn Error>> {
    let ipcon = IpConnection::new(); // Create IP connection.
    let ow = OutdoorWeatherBricklet::new(UID, &ipcon); // Create device object.

    ipcon.connect((HOST, PORT)).recv()??; // Connect to brickd.
                                          // Don't use device before ipcon is connected.

    // Enable station data callbacks
    ow.set_station_callback_configuration(true);

    // Enable sensor data callbacks
    ow.set_sensor_callback_configuration(true);

    let station_data_receiver = ow.get_station_data_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `ow` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for station_data in station_data_receiver {
            println!("Identifier (Station): {}", station_data.identifier);
            println!("Temperature (Station): {} °C", station_data.temperature as f32 / 10.0);
            println!("Humidity (Station): {} %RH", station_data.humidity);
            println!("Wind Speed (Station): {} m/s", station_data.wind_speed as f32 / 10.0);
            println!("Gust Speed (Station): {} m/s", station_data.gust_speed as f32 / 10.0);
            println!("Rain (Station): {} mm", station_data.rain as f32 / 10.0);

            if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_N {
                println!("Wind Direction (Station): N");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNE {
                println!("Wind Direction (Station): NNE");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NE {
                println!("Wind Direction (Station): NE");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ENE {
                println!("Wind Direction (Station): ENE");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_E {
                println!("Wind Direction (Station): E");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ESE {
                println!("Wind Direction (Station): ESE");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SE {
                println!("Wind Direction (Station): SE");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSE {
                println!("Wind Direction (Station): SSE");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_S {
                println!("Wind Direction (Station): S");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSW {
                println!("Wind Direction (Station): SSW");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SW {
                println!("Wind Direction (Station): SW");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WSW {
                println!("Wind Direction (Station): WSW");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_W {
                println!("Wind Direction (Station): W");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WNW {
                println!("Wind Direction (Station): WNW");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NW {
                println!("Wind Direction (Station): NW");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNW {
                println!("Wind Direction (Station): NNW");
            } else if station_data.wind_direction == OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ERROR {
                println!("Wind Direction (Station): Error");
            }

            println!("Battery Low (Station): {}", station_data.battery_low);
            println!();
        }
    });

    let sensor_data_receiver = ow.get_sensor_data_callback_receiver();

    // Spawn thread to handle received callback messages.
    // This thread ends when the `ow` object
    // is dropped, so there is no need for manual cleanup.
    thread::spawn(move || {
        for sensor_data in sensor_data_receiver {
            println!("Identifier (Sensor): {}", sensor_data.identifier);
            println!("Temperature (Sensor): {} °C", sensor_data.temperature as f32 / 10.0);
            println!("Humidity (Sensor): {} %RH", sensor_data.humidity);
            println!();
        }
    });

    println!("Press enter to exit.");
    let mut _input = String::new();
    io::stdin().read_line(&mut _input)?;
    ipcon.disconnect();
    Ok(())
}

API

To allow non-blocking usage, nearly every function of the Rust bindings returns a wrapper around a mpsc::Receiver. To block until the function has finished and get your result, call one of the receiver's recv variants. Those return either the result sent by the device, or any error occured.

Functions returning a result directly will block until the device has finished processing the request.

All functions listed below are thread-safe, those which return a receiver are lock-free.

Basic Functions

pub fn OutdoorWeatherBricklet::new(uid: &str, ip_connection: &IpConnection) → OutdoorWeatherBricklet

Creates a new OutdoorWeatherBricklet object with the unique device ID uid and adds it to the IPConnection ipcon:

This device object can be used after the IP connection has been connected (see examples above).

pub fn OutdoorWeatherBricklet::get_station_identifiers(&self) → Result<Vec<u8>, BrickletRecvTimeoutError>

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.

pub fn OutdoorWeatherBricklet::get_sensor_identifiers(&self) → Result<Vec<u8>, BrickletRecvTimeoutError>

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.

pub fn OutdoorWeatherBricklet::get_station_data(&self, identifier: u8) → ConvertingReceiver<StationData>

Returns the last received data for a station with the given identifier. Call OutdoorWeatherBricklet::get_station_identifiers 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:

  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_N = 0
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNE = 1
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NE = 2
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ENE = 3
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_E = 4
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ESE = 5
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SE = 6
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSE = 7
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_S = 8
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSW = 9
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SW = 10
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WSW = 11
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_W = 12
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WNW = 13
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NW = 14
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNW = 15
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ERROR = 255
pub fn OutdoorWeatherBricklet::get_sensor_data(&self, identifier: u8) → ConvertingReceiver<SensorData>

Returns the last measured data for a sensor with the given identifier. Call OutdoorWeatherBricklet::get_sensor_identifiers 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

pub fn OutdoorWeatherBricklet::get_api_version(&self) → [u8; 3]

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.

pub fn OutdoorWeatherBricklet::get_response_expected(&mut self, function_id: u8) → bool

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 OutdoorWeatherBricklet::set_response_expected. 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 OutdoorWeatherBricklet::set_response_expected for the list of function ID constants available for this function.

pub fn OutdoorWeatherBricklet::set_response_expected(&mut self, function_id: u8, response_expected: bool) → ()

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:

  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_SET_STATION_CALLBACK_CONFIGURATION = 5
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION = 7
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_SET_STATUS_LED_CONFIG = 239
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_RESET = 243
  • OUTDOOR_WEATHER_BRICKLET_FUNCTION_WRITE_UID = 248
pub fn OutdoorWeatherBricklet::set_response_expected_all(&mut self, response_expected: bool) → ()

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

pub fn OutdoorWeatherBricklet::get_spitfp_error_count(&self) → ConvertingReceiver<SpitfpErrorCount>

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.

pub fn OutdoorWeatherBricklet::set_bootloader_mode(&self, mode: u8) → ConvertingReceiver<u8>

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:

  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_OK = 0
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_INVALID_MODE = 1
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_NO_CHANGE = 2
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_STATUS_CRC_MISMATCH = 5
pub fn OutdoorWeatherBricklet::get_bootloader_mode(&self) → ConvertingReceiver<u8>

Returns the current bootloader mode, see OutdoorWeatherBricklet::set_bootloader_mode.

The following constants are available for this function:

  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER = 0
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE = 1
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • OUTDOOR_WEATHER_BRICKLET_BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
pub fn OutdoorWeatherBricklet::set_write_firmware_pointer(&self, pointer: u32) → ConvertingReceiver<()>

Sets the firmware pointer for OutdoorWeatherBricklet::write_firmware. 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.

pub fn OutdoorWeatherBricklet::write_firmware(&self, data: [u8; 64]) → ConvertingReceiver<u8>

Writes 64 Bytes of firmware at the position as written by OutdoorWeatherBricklet::set_write_firmware_pointer 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.

pub fn OutdoorWeatherBricklet::set_status_led_config(&self, config: u8) → ConvertingReceiver<()>

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:

  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn OutdoorWeatherBricklet::get_status_led_config(&self) → ConvertingReceiver<u8>

Returns the configuration as set by OutdoorWeatherBricklet::set_status_led_config

The following constants are available for this function:

  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_OFF = 0
  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_ON = 1
  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • OUTDOOR_WEATHER_BRICKLET_STATUS_LED_CONFIG_SHOW_STATUS = 3
pub fn OutdoorWeatherBricklet::get_chip_temperature(&self) → ConvertingReceiver<i16>

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.

pub fn OutdoorWeatherBricklet::reset(&self) → ConvertingReceiver<()>

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!

pub fn OutdoorWeatherBricklet::write_uid(&self, uid: u32) → ConvertingReceiver<()>

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.

pub fn OutdoorWeatherBricklet::read_uid(&self) → ConvertingReceiver<u32>

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

pub fn OutdoorWeatherBricklet::get_identity(&self) → ConvertingReceiver<Identity>

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

pub fn OutdoorWeatherBricklet::set_station_callback_configuration(&self, enable_callback: bool) → ConvertingReceiver<()>

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

pub fn OutdoorWeatherBricklet::get_station_callback_configuration(&self) → ConvertingReceiver<bool>

Returns the configuration as set by OutdoorWeatherBricklet::set_station_callback_configuration.

pub fn OutdoorWeatherBricklet::set_sensor_callback_configuration(&self, enable_callback: bool) → ConvertingReceiver<()>

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

pub fn OutdoorWeatherBricklet::get_sensor_callback_configuration(&self) → ConvertingReceiver<bool>

Returns the configuration as set by OutdoorWeatherBricklet::set_sensor_callback_configuration.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the corresponding get_*_callback_receiver function, which returns a receiver for callback events.

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.

pub fn OutdoorWeatherBricklet::get_station_data_callback_receiver(&self) → ConvertingCallbackReceiver<StationDataEvent>

Receivers created with this function receive Station Data events.

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

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

Turn the callback on/off with OutdoorWeatherBricklet::set_station_callback_configuration (by default it is turned off).

The following constants are available for this function:

  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_N = 0
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNE = 1
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NE = 2
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ENE = 3
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_E = 4
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ESE = 5
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SE = 6
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSE = 7
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_S = 8
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SSW = 9
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_SW = 10
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WSW = 11
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_W = 12
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_WNW = 13
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NW = 14
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_NNW = 15
  • OUTDOOR_WEATHER_BRICKLET_WIND_DIRECTION_ERROR = 255
pub fn OutdoorWeatherBricklet::get_sensor_data_callback_receiver(&self) → ConvertingCallbackReceiver<SensorDataEvent>

Receivers created with this function receive Sensor Data events.

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

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

Turn the callback on/off with OutdoorWeatherBricklet::set_sensor_callback_configuration (by default it is turned off).

Constants

OutdoorWeatherBricklet::DEVICE_IDENTIFIER

This constant is used to identify a Outdoor Weather Bricklet.

The OutdoorWeatherBricklet::get_identity function and the IpConnection::get_enumerate_callback_receiver callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

OutdoorWeatherBricklet::DEVICE_DISPLAY_NAME

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