Class: Tinkerforge::BrickletOutdoorWeather

Inherits:
Device
  • Object
show all
Defined in:
lib/tinkerforge/bricklet_outdoor_weather.rb

Overview

433MHz receiver for outdoor weather station

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

288
DEVICE_DISPLAY_NAME =

:nodoc:

'Outdoor Weather Bricklet'
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).

9
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).

10
FUNCTION_GET_STATION_IDENTIFIERS_LOW_LEVEL =

:nodoc:

1
FUNCTION_GET_SENSOR_IDENTIFIERS_LOW_LEVEL =

:nodoc:

2
FUNCTION_GET_STATION_DATA =

:nodoc:

3
FUNCTION_GET_SENSOR_DATA =

:nodoc:

4
FUNCTION_SET_STATION_CALLBACK_CONFIGURATION =

:nodoc:

5
FUNCTION_GET_STATION_CALLBACK_CONFIGURATION =

:nodoc:

6
FUNCTION_SET_SENSOR_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_GET_SENSOR_CALLBACK_CONFIGURATION =

:nodoc:

8
FUNCTION_GET_SPITFP_ERROR_COUNT =

:nodoc:

234
FUNCTION_SET_BOOTLOADER_MODE =

:nodoc:

235
FUNCTION_GET_BOOTLOADER_MODE =

:nodoc:

236
FUNCTION_SET_WRITE_FIRMWARE_POINTER =

:nodoc:

237
FUNCTION_WRITE_FIRMWARE =

:nodoc:

238
FUNCTION_SET_STATUS_LED_CONFIG =

:nodoc:

239
FUNCTION_GET_STATUS_LED_CONFIG =

:nodoc:

240
FUNCTION_GET_CHIP_TEMPERATURE =

:nodoc:

242
FUNCTION_RESET =

:nodoc:

243
FUNCTION_WRITE_UID =

:nodoc:

248
FUNCTION_READ_UID =

:nodoc:

249
FUNCTION_GET_IDENTITY =

:nodoc:

255
WIND_DIRECTION_N =

:nodoc:

0
WIND_DIRECTION_NNE =

:nodoc:

1
WIND_DIRECTION_NE =

:nodoc:

2
WIND_DIRECTION_ENE =

:nodoc:

3
WIND_DIRECTION_E =

:nodoc:

4
WIND_DIRECTION_ESE =

:nodoc:

5
WIND_DIRECTION_SE =

:nodoc:

6
WIND_DIRECTION_SSE =

:nodoc:

7
WIND_DIRECTION_S =

:nodoc:

8
WIND_DIRECTION_SSW =

:nodoc:

9
WIND_DIRECTION_SW =

:nodoc:

10
WIND_DIRECTION_WSW =

:nodoc:

11
WIND_DIRECTION_W =

:nodoc:

12
WIND_DIRECTION_WNW =

:nodoc:

13
WIND_DIRECTION_NW =

:nodoc:

14
WIND_DIRECTION_NNW =

:nodoc:

15
WIND_DIRECTION_ERROR =

:nodoc:

255
BOOTLOADER_MODE_BOOTLOADER =

:nodoc:

0
BOOTLOADER_MODE_FIRMWARE =

:nodoc:

1
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT =

:nodoc:

2
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT =

:nodoc:

3
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT =

:nodoc:

4
BOOTLOADER_STATUS_OK =

:nodoc:

0
BOOTLOADER_STATUS_INVALID_MODE =

:nodoc:

1
BOOTLOADER_STATUS_NO_CHANGE =

:nodoc:

2
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT =

:nodoc:

3
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT =

:nodoc:

4
BOOTLOADER_STATUS_CRC_MISMATCH =

:nodoc:

5
STATUS_LED_CONFIG_OFF =

:nodoc:

0
STATUS_LED_CONFIG_ON =

:nodoc:

1
STATUS_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
STATUS_LED_CONFIG_SHOW_STATUS =

:nodoc:

3

Constants inherited from Device

Device::DEVICE_IDENTIFIER_CHECK_MATCH, Device::DEVICE_IDENTIFIER_CHECK_MISMATCH, Device::DEVICE_IDENTIFIER_CHECK_PENDING, Device::RESPONSE_EXPECTED_ALWAYS_TRUE, Device::RESPONSE_EXPECTED_FALSE, Device::RESPONSE_EXPECTED_INVALID_FUNCTION_ID, Device::RESPONSE_EXPECTED_TRUE

Instance Attribute Summary

Attributes inherited from Device

#callback_formats, #expected_response_function_id, #expected_response_sequence_number, #high_level_callbacks, #registered_callbacks, #replaced, #uid

Instance Method Summary collapse

Methods inherited from Device

#check_validity, #dequeue_response, #enqueue_response, #get_api_version, #get_response_expected, #send_request, #set_response_expected, #set_response_expected_all

Constructor Details

#initialize(uid, ipcon) ⇒ BrickletOutdoorWeather

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 94

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

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletOutdoorWeather#set_bootloader_mode.



248
249
250
251
252
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 248

def get_bootloader_mode
  check_validity

  send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C'
end

#get_chip_temperature ⇒ Object

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.



306
307
308
309
310
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 306

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end

#get_identity ⇒ Object

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|



353
354
355
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 353

def get_identity
  send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S'
end

#get_sensor_callback_configuration ⇒ Object

Returns the configuration as set by BrickletOutdoorWeather#set_sensor_callback_configuration.



209
210
211
212
213
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 209

def get_sensor_callback_configuration
  check_validity

  send_request FUNCTION_GET_SENSOR_CALLBACK_CONFIGURATION, [], '', 9, '?'
end

#get_sensor_data(identifier) ⇒ Object

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



181
182
183
184
185
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 181

def get_sensor_data(identifier)
  check_validity

  send_request FUNCTION_GET_SENSOR_DATA, [identifier], 'C', 13, 's C S'
end

#get_sensor_identifiers ⇒ Object

Returns the identifiers (number between 0 and 255) of all ‘sensors <www.tinkerforge.com/en/shop/accessories/sensors/temperature-humidity-sensor-th-6148.html>`__ 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.



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 406

def get_sensor_identifiers
  identifiers_length = nil # assigned in block
  identifiers_data = nil # assigned in block

  @stream_mutex.synchronize {
    ret = get_sensor_identifiers_low_level
    identifiers_length = ret[0]
    identifiers_chunk_offset = ret[1]
    identifiers_out_of_sync = identifiers_chunk_offset != 0
    identifiers_data = ret[2]

    while not identifiers_out_of_sync and identifiers_data.length < identifiers_length
      ret = get_sensor_identifiers_low_level
      identifiers_length = ret[0]
      identifiers_chunk_offset = ret[1]
      identifiers_out_of_sync = identifiers_chunk_offset != identifiers_data.length
      identifiers_data += ret[2]
    end

    if identifiers_out_of_sync # discard remaining stream to bring it back in-sync
      while identifiers_chunk_offset + 60 < identifiers_length
        ret = get_sensor_identifiers_low_level
        identifiers_length = ret[0]
        identifiers_chunk_offset = ret[1]
      end

      raise StreamOutOfSyncException, 'Identifiers stream is out-of-sync'
    end
  }

  identifiers_data[0, identifiers_length]
end

#get_sensor_identifiers_low_level ⇒ Object

Returns the identifiers (number between 0 and 255) of all ‘sensors <www.tinkerforge.com/en/shop/accessories/sensors/temperature-humidity-sensor-th-6148.html>`__ 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.



148
149
150
151
152
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 148

def get_sensor_identifiers_low_level
  check_validity

  send_request FUNCTION_GET_SENSOR_IDENTIFIERS_LOW_LEVEL, [], '', 72, 'S S C60'
end

#get_spitfp_error_count ⇒ Object

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.



226
227
228
229
230
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 226

def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end

#get_station_callback_configuration ⇒ Object

Returns the configuration as set by BrickletOutdoorWeather#set_station_callback_configuration.



195
196
197
198
199
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 195

def get_station_callback_configuration
  check_validity

  send_request FUNCTION_GET_STATION_CALLBACK_CONFIGURATION, [], '', 9, '?'
end

#get_station_data(identifier) ⇒ Object

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



167
168
169
170
171
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 167

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_station_identifiers ⇒ Object

Returns the identifiers (number between 0 and 255) of all ‘stations <www.tinkerforge.com/en/shop/accessories/sensors/outdoor-weather-station-ws-6147.html>`__ 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.



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 365

def get_station_identifiers
  identifiers_length = nil # assigned in block
  identifiers_data = nil # assigned in block

  @stream_mutex.synchronize {
    ret = get_station_identifiers_low_level
    identifiers_length = ret[0]
    identifiers_chunk_offset = ret[1]
    identifiers_out_of_sync = identifiers_chunk_offset != 0
    identifiers_data = ret[2]

    while not identifiers_out_of_sync and identifiers_data.length < identifiers_length
      ret = get_station_identifiers_low_level
      identifiers_length = ret[0]
      identifiers_chunk_offset = ret[1]
      identifiers_out_of_sync = identifiers_chunk_offset != identifiers_data.length
      identifiers_data += ret[2]
    end

    if identifiers_out_of_sync # discard remaining stream to bring it back in-sync
      while identifiers_chunk_offset + 60 < identifiers_length
        ret = get_station_identifiers_low_level
        identifiers_length = ret[0]
        identifiers_chunk_offset = ret[1]
      end

      raise StreamOutOfSyncException, 'Identifiers stream is out-of-sync'
    end
  }

  identifiers_data[0, identifiers_length]
end

#get_station_identifiers_low_level ⇒ Object

Returns the identifiers (number between 0 and 255) of all ‘stations <www.tinkerforge.com/en/shop/accessories/sensors/outdoor-weather-station-ws-6147.html>`__ 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.



134
135
136
137
138
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 134

def get_station_identifiers_low_level
  check_validity

  send_request FUNCTION_GET_STATION_IDENTIFIERS_LOW_LEVEL, [], '', 72, 'S S C60'
end

#get_status_led_config ⇒ Object

Returns the configuration as set by BrickletOutdoorWeather#set_status_led_config



294
295
296
297
298
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 294

def get_status_led_config
  check_validity

  send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C'
end

#read_uid ⇒ Object

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



337
338
339
340
341
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 337

def read_uid
  check_validity

  send_request FUNCTION_READ_UID, [], '', 12, 'L'
end

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



440
441
442
443
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 440

def register_callback(id, &block)
  callback = block
  @registered_callbacks[id] = callback
end

#reset ⇒ Object

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!



318
319
320
321
322
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 318

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end

#set_bootloader_mode(mode) ⇒ Object

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.



241
242
243
244
245
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 241

def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end

#set_sensor_callback_configuration(enable_callback) ⇒ Object

Turns callback for sensor data on or off.



202
203
204
205
206
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 202

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) ⇒ Object

Turns callback for station data on or off.



188
189
190
191
192
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 188

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) ⇒ Object

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.



287
288
289
290
291
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 287

def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

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.



260
261
262
263
264
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 260

def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end

#write_firmware(data) ⇒ Object

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.



274
275
276
277
278
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 274

def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end

#write_uid(uid) ⇒ Object

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.



329
330
331
332
333
 
# File 'lib/tinkerforge/bricklet_outdoor_weather.rb', line 329

def write_uid(uid)
  check_validity

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