class Tinkerforge::BrickletOutdoorWeather

433MHz receiver for outdoor weather station

Constants

CALLBACK_SENSOR_DATA

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

CALLBACK_STATION_DATA

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

Public Class Methods

new(uid, ipcon) click to toggle source

Creates an object with the unique device ID uid and adds it to the IP Connection ipcon.

Calls superclass method
# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 93
def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_STATION_IDENTIFIERS_LOW_LEVEL] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_SENSOR_IDENTIFIERS_LOW_LEVEL] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_STATION_DATA] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_SENSOR_DATA] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STATION_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_STATION_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_SENSOR_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_STATION_DATA] = [26, 'C s C L L L C ?']
  @callback_formats[CALLBACK_SENSOR_DATA] = [12, 'C s C']

  @ipcon.add_device self
end

Public Instance Methods

get_bootloader_mode() click to toggle source

Returns the current bootloader mode, see BrickletOutdoorWeather#set_bootloader_mode.

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 247
def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end
get_chip_temperature() click to toggle source

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.

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 305
def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end
get_identity() click to toggle source

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 :ref:`Isolator Bricklet <isolator_bricklet>` is always at position 'z'.

The device identifier numbers can be found :ref:`here <device_identifier>`. |device_identifier_constant|

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 352
def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end
get_sensor_callback_configuration() click to toggle source

Returns the configuration as set by BrickletOutdoorWeather#set_sensor_callback_configuration.

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 208
def get_sensor_callback_configuration
  check_validity

  send_request FUNCTION_GET_SENSOR_CALLBACK_CONFIGURATION, [], '', 9, '?'
end
get_sensor_data(identifier) click to toggle source

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

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 180
def get_sensor_data(identifier)
  check_validity

  send_request FUNCTION_GET_SENSOR_DATA, [identifier], 'C', 13, 's C S'
end
get_spitfp_error_count() click to toggle source

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.

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 225
def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end
get_station_callback_configuration() click to toggle source

Returns the configuration as set by BrickletOutdoorWeather#set_station_callback_configuration.

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 194
def get_station_callback_configuration
  check_validity

  send_request FUNCTION_GET_STATION_CALLBACK_CONFIGURATION, [], '', 9, '?'
end
get_station_data(identifier) click to toggle source

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

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 166
def get_station_data(identifier)
  check_validity

  send_request FUNCTION_GET_STATION_DATA, [identifier], 'C', 27, 's C L L L C ? S'
end
get_status_led_config() click to toggle source

Returns the configuration as set by BrickletOutdoorWeather#set_status_led_config

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 293
def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end
read_uid() click to toggle source

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

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 336
def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end
register_callback(id, &block) click to toggle source

Registers a callback with ID id to the block block.

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 439
def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end
reset() click to toggle source

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!

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 317
def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end
set_bootloader_mode(mode) click to toggle source

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.

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 240
def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end
set_sensor_callback_configuration(enable_callback) click to toggle source

Turns callback for sensor data on or off.

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 201
def set_sensor_callback_configuration(enable_callback)
  check_validity

  send_request FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION, [enable_callback], '?', 8, ''
end
set_station_callback_configuration(enable_callback) click to toggle source

Turns callback for station data on or off.

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 187
def set_station_callback_configuration(enable_callback)
  check_validity

  send_request FUNCTION_SET_STATION_CALLBACK_CONFIGURATION, [enable_callback], '?', 8, ''
end
set_status_led_config(config) click to toggle source

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.

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 286
def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end
set_write_firmware_pointer(pointer) click to toggle source

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

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 259
def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end
write_firmware(data) click to toggle source

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

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 273
def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end
write_uid(uid) click to toggle source

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.

# File lib/tinkerforge/bricklet_outdoor_weather.rb, line 328
def write_uid(uid)
  check_validity

  send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
end