Ruby - Outdoor Weather Bricklet

This is the description of the Ruby 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 Ruby API bindings is part of their general description.

Examples

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

Callback

Download (example_callback.rb)

 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
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_outdoor_weather'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Outdoor Weather Bricklet

ipcon = IPConnection.new # Create IP connection
ow = BrickletOutdoorWeather.new 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.set_station_callback_configuration true

# Enable sensor data callbacks
ow.set_sensor_callback_configuration true

# Register station data callback
ow.register_callback(BrickletOutdoorWeather::CALLBACK_STATION_DATA) do |identifier,
                                                                        temperature,
                                                                        humidity,
                                                                        wind_speed,
                                                                        gust_speed, rain,
                                                                        wind_direction,
                                                                        battery_low|
  puts "Identifier (Station): #{identifier}"
  puts "Temperature (Station): #{temperature/10.0} °C"
  puts "Humidity (Station): #{humidity} %RH"
  puts "Wind Speed (Station): #{wind_speed/10.0} m/s"
  puts "Gust Speed (Station): #{gust_speed/10.0} m/s"
  puts "Rain (Station): #{rain/10.0} mm"
  puts "Wind Direction (Station): #{wind_direction}"
  puts "Battery Low (Station): #{battery_low}"
  puts ''
end

# Register sensor data callback
ow.register_callback(BrickletOutdoorWeather::CALLBACK_SENSOR_DATA) do |identifier,
                                                                       temperature,
                                                                       humidity|
  puts "Identifier (Sensor): #{identifier}"
  puts "Temperature (Sensor): #{temperature/10.0} °C"
  puts "Humidity (Sensor): #{humidity} %RH"
  puts ''
end

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

All methods listed below are thread-safe.

Basic Functions

BrickletOutdoorWeather::new(uid, ipcon) → outdoor_weather
Parameters:
  • uid -- str
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

outdoor_weather = BrickletOutdoorWeather.new 'YOUR_DEVICE_UID', ipcon

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

BrickletOutdoorWeather#get_station_identifiers → [int, int, ...]

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.

BrickletOutdoorWeather#get_sensor_identifiers → [int, int, ...]

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.

BrickletOutdoorWeather#get_station_data(identifier) → [int, int, int, int, int, int, bool, int]
Parameters:identifier -- int

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

  • 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

The returned array has the values temperature, humidity, wind_speed, gust_speed, rain, wind_direction, battery_low and last_change.

BrickletOutdoorWeather#get_sensor_data(identifier) → [int, int, int]
Parameters:identifier -- int

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

The returned array has the values temperature, humidity and last_change.

Advanced Functions

BrickletOutdoorWeather#get_api_version → [int, int, int]

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.

BrickletOutdoorWeather#get_response_expected(function_id) → bool
Parameters:function_id -- int

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

BrickletOutdoorWeather#set_response_expected(function_id, response_expected) → nil
Parameters:
  • function_id -- int
  • 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:

  • 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
BrickletOutdoorWeather#set_response_expected_all(response_expected) → nil
Parameters:response_expected -- bool

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

BrickletOutdoorWeather#get_spitfp_error_count → [int, int, int, int]

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.

The returned array has the values error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

BrickletOutdoorWeather#set_bootloader_mode(mode) → int
Parameters:mode -- int

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:

  • 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
  • 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
BrickletOutdoorWeather#get_bootloader_mode → int

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

  • 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
BrickletOutdoorWeather#set_write_firmware_pointer(pointer) → nil
Parameters:pointer -- int

Sets the firmware pointer for #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.

BrickletOutdoorWeather#write_firmware(data) → int
Parameters:data -- [int, int, ..61x.., int]

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

BrickletOutdoorWeather#set_status_led_config(config) → nil
Parameters:config -- int

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:

  • 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
BrickletOutdoorWeather#get_status_led_config → int

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

  • 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
BrickletOutdoorWeather#get_chip_temperature → int

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.

BrickletOutdoorWeather#reset → nil

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!

BrickletOutdoorWeather#write_uid(uid) → nil
Parameters:uid -- int

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.

BrickletOutdoorWeather#read_uid → int

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

BrickletOutdoorWeather#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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.

The returned array has the values uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

BrickletOutdoorWeather#register_callback(callback_id) { |param [, ...]| block } → nil
Parameters:callback_id -- int

Registers the given block with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletOutdoorWeather#set_station_callback_configuration(enable_callback) → nil
Parameters:enable_callback -- bool

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

BrickletOutdoorWeather#get_station_callback_configuration → bool

Returns the configuration as set by #set_station_callback_configuration.

BrickletOutdoorWeather#set_sensor_callback_configuration(enable_callback) → nil
Parameters:enable_callback -- bool

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

BrickletOutdoorWeather#get_sensor_callback_configuration → bool

Returns the configuration as set by #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 #register_callback function of the device object. The first parameter is the callback ID and the second parameter is a block:

outdoor_weather.register_callback BrickletOutdoorWeather::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and 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.

BrickletOutdoorWeather::CALLBACK_STATION_DATA
Parameters:
  • identifier -- int
  • temperature -- int
  • humidity -- int
  • wind_speed -- int
  • gust_speed -- int
  • rain -- int
  • wind_direction -- int
  • battery_low -- bool

Reports the station data every time a new data packet is received. See #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 #set_station_callback_configuration (by default it is turned off).

The following constants are available for this function:

  • 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
BrickletOutdoorWeather::CALLBACK_SENSOR_DATA
Parameters:
  • identifier -- int
  • temperature -- int
  • humidity -- int

Reports the sensor data every time a new data packet is received. See #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 #set_sensor_callback_configuration (by default it is turned off).

Constants

BrickletOutdoorWeather::DEVICE_IDENTIFIER

This constant is used to identify a Outdoor Weather Bricklet.

The #get_identity() function and the ::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletOutdoorWeather::DEVICE_DISPLAY_NAME

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