Ruby - Outdoor Weather Bricklet¶

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

#!/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"

  if wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_N
    puts "Wind Direction (Station): N"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_NNE
    puts "Wind Direction (Station): NNE"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_NE
    puts "Wind Direction (Station): NE"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_ENE
    puts "Wind Direction (Station): ENE"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_E
    puts "Wind Direction (Station): E"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_ESE
    puts "Wind Direction (Station): ESE"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_SE
    puts "Wind Direction (Station): SE"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_SSE
    puts "Wind Direction (Station): SSE"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_S
    puts "Wind Direction (Station): S"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_SSW
    puts "Wind Direction (Station): SSW"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_SW
    puts "Wind Direction (Station): SW"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_WSW
    puts "Wind Direction (Station): WSW"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_W
    puts "Wind Direction (Station): W"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_WNW
    puts "Wind Direction (Station): WNW"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_NW
    puts "Wind Direction (Station): NW"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_NNW
    puts "Wind Direction (Station): NNW"
  elsif wind_direction == BrickletOutdoorWeather::WIND_DIRECTION_ERROR
    puts "Wind Direction (Station): Error"
  end

  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

Basic Functions¶

BrickletOutdoorWeather::new(uid, ipcon) → outdoor_weather¶

Parameters:	uid – Type: str ipcon – Type: IPConnection
Returns:	outdoor_weather – Type: BrickletOutdoorWeather

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.

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

Returns:	identifiers – Type: [int, ...], 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.

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

Returns:	identifiers – Type: [int, ...], 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.

BrickletOutdoorWeather#get_station_data(identifier) → [int, int, int, int, int, int, bool, int]¶

Parameters:

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

Return Array:

0: temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 650] 1: humidity – Type: int, Unit: 1 %, Range: [10 to 99] 2: wind_speed – Type: int, Unit: 1/10 m/s, Range: [0 to 232 - 1] 3: gust_speed – Type: int, Unit: 1/10 m/s, Range: [0 to 232 - 1] 4: rain – Type: int, Unit: 1/10 mm, Range: [0 to 232 - 1] 5: wind_direction – Type: int, Range: See constants 6: battery_low – Type: bool 7: last_change – Type: int, Unit: 1 s, Range: [0 to 216 - 1]

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,
• 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 wind_direction:

• 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#get_sensor_data(identifier) → [int, int, int]¶

Parameters:	identifier – Type: int, Range: [0 to 255]
Return Array:	0: temperature – Type: int, Unit: 1/10 °C, Range: [-215 to 215 - 1] 1: humidity – Type: int, Unit: 1 %, Range: [0 to 255] 2: last_change – Type: int, Unit: 1 s, Range: [0 to 216 - 1]

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

Advanced Functions¶

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

Return Array:	0: error_count_ack_checksum – Type: int, Range: [0 to 232 - 1] 1: error_count_message_checksum – Type: int, Range: [0 to 232 - 1] 2: error_count_frame – Type: int, Range: [0 to 232 - 1] 3: error_count_overflow – Type: int, 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.

BrickletOutdoorWeather#set_status_led_config(config) → nil¶

Parameters:	config – Type: int, 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

BrickletOutdoorWeather#get_status_led_config → int¶

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

Returns the configuration as set by #set_status_led_config

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

BrickletOutdoorWeather#get_chip_temperature → int¶

Returns:	temperature – Type: int, 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.

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#get_identity → [str, str, chr, [int, ...], [int, ...], int]¶

Return Array:

0: uid – Type: str, Length: up to 8 1: connected_uid – Type: str, Length: up to 8 2: position – Type: chr, Range: ['a' to 'h', 'z'] 3: hardware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 4: firmware_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, Range: [0 to 255] 5: device_identifier – Type: int, 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¶

BrickletOutdoorWeather#register_callback(callback_id) { |param [, ...]| block } → nil¶

Parameters:	callback_id – Type: 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 – Type: bool, Default: false

Turns callback for station data on or off.

BrickletOutdoorWeather#get_station_callback_configuration → bool¶

Returns:	enable_callback – Type: bool, Default: false

Returns the configuration as set by #set_station_callback_configuration.

BrickletOutdoorWeather#set_sensor_callback_configuration(enable_callback) → nil¶

Parameters:	enable_callback – Type: bool, Default: false

Turns callback for sensor data on or off.

BrickletOutdoorWeather#get_sensor_callback_configuration → bool¶

Returns:	enable_callback – Type: bool, Default: false

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.

BrickletOutdoorWeather::CALLBACK_STATION_DATA¶

Callback Parameters:

identifier – Type: int, Range: [0 to 255] temperature – Type: int, Unit: 1/10 °C, Range: [-400 to 650] humidity – Type: int, Unit: 1 %, Range: [10 to 99] wind_speed – Type: int, Unit: 1/10 m/s, Range: [0 to 232 - 1] gust_speed – Type: int, Unit: 1/10 m/s, Range: [0 to 232 - 1] rain – Type: int, Unit: 1/10 mm, Range: [0 to 232 - 1] wind_direction – Type: int, Range: See constants battery_low – Type: 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:

For wind_direction:

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

Callback Parameters:	identifier – Type: int, Range: [0 to 255] temperature – Type: int, Unit: 1/10 °C, Range: [-215 to 215 - 1] humidity – Type: int, Unit: 1 %, Range: [0 to 255]

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

For each sensor 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).

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.

BrickletOutdoorWeather#get_api_version → [int, ...]¶

Return Array:	0: api_version – Type: [int, ...], Length: 3 0: major – Type: int, Range: [0 to 255] 1: minor – Type: int, Range: [0 to 255] 2: revision – Type: int, 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.

BrickletOutdoorWeather#get_response_expected(function_id) → bool¶

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

The following constants are available for this function:

For function_id:

• 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(function_id, response_expected) → nil¶

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

The following constants are available for this function:

For function_id:

• 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 – Type: bool

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.

BrickletOutdoorWeather#set_bootloader_mode(mode) → int¶

Parameters:	mode – Type: int, Range: See constants
Returns:	status – Type: int, 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

BrickletOutdoorWeather#get_bootloader_mode → int¶

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

Returns the current bootloader mode, see #set_bootloader_mode.

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

BrickletOutdoorWeather#set_write_firmware_pointer(pointer) → nil¶

Parameters:	pointer – Type: int, Unit: 1 B, Range: [0 to 232 - 1]

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 – Type: [int, ...], Length: 64, Range: [0 to 255]
Returns:	status – Type: int, Range: [0 to 255]

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#write_uid(uid) → nil¶

Parameters:	uid – Type: int, 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.

BrickletOutdoorWeather#read_uid → int¶

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

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

Constants¶

BrickletOutdoorWeather::DEVICE_IDENTIFIER¶

This constant is used to identify a Outdoor Weather Bricklet.

The #get_identity() function and the IPConnection::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.