Class: Tinkerforge::BrickletCO2

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

Overview

Measures CO2 concentration in ppm

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

262
DEVICE_DISPLAY_NAME =

:nodoc:

'CO2 Bricklet'
CALLBACK_CO2_CONCENTRATION =

This callback is triggered periodically with the period that is set by BrickletCO2#set_co2_concentration_callback_period. The parameter is the CO2 concentration of the sensor.

The CALLBACK_CO2_CONCENTRATION callback is only triggered if the CO2 concentration has changed since the last triggering.

8
CALLBACK_CO2_CONCENTRATION_REACHED =

This callback is triggered when the threshold as set by BrickletCO2#set_co2_concentration_callback_threshold is reached. The parameter is the CO2 concentration.

If the threshold keeps being reached, the callback is triggered periodically with the period as set by BrickletCO2#set_debounce_period.

9
FUNCTION_GET_CO2_CONCENTRATION =

:nodoc:

1
FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD =

:nodoc:

2
FUNCTION_GET_CO2_CONCENTRATION_CALLBACK_PERIOD =

:nodoc:

3
FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD =

:nodoc:

4
FUNCTION_GET_CO2_CONCENTRATION_CALLBACK_THRESHOLD =

:nodoc:

5
FUNCTION_SET_DEBOUNCE_PERIOD =

:nodoc:

6
FUNCTION_GET_DEBOUNCE_PERIOD =

:nodoc:

7
FUNCTION_GET_IDENTITY =

:nodoc:

255
THRESHOLD_OPTION_OFF =

:nodoc:

'x'
THRESHOLD_OPTION_OUTSIDE =

:nodoc:

'o'
THRESHOLD_OPTION_INSIDE =

:nodoc:

'i'
THRESHOLD_OPTION_SMALLER =

:nodoc:

'<'
THRESHOLD_OPTION_GREATER =

:nodoc:

'>'

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

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/tinkerforge/bricklet_co2.rb', line 53

def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_CO2_CONCENTRATION] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_CO2_CONCENTRATION_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_CO2_CONCENTRATION_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_DEBOUNCE_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_CO2_CONCENTRATION] = [10, 'S']
  @callback_formats[CALLBACK_CO2_CONCENTRATION_REACHED] = [10, 'S']

  @ipcon.add_device self
end

Instance Method Details

#get_co2_concentration ⇒ Object

Returns the measured CO2 concentration.

If you want to get the CO2 concentration periodically, it is recommended to use the CALLBACK_CO2_CONCENTRATION callback and set the period with BrickletCO2#set_co2_concentration_callback_period.



78
79
80
81
82
 
# File 'lib/tinkerforge/bricklet_co2.rb', line 78

def get_co2_concentration
  check_validity

  send_request FUNCTION_GET_CO2_CONCENTRATION, [], '', 10, 'S'
end

#get_co2_concentration_callback_period ⇒ Object

Returns the period as set by BrickletCO2#set_co2_concentration_callback_period.



96
97
98
99
100
 
# File 'lib/tinkerforge/bricklet_co2.rb', line 96

def get_co2_concentration_callback_period
  check_validity

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

#get_co2_concentration_callback_threshold ⇒ Object

Returns the threshold as set by BrickletCO2#set_co2_concentration_callback_threshold.



120
121
122
123
124
 
# File 'lib/tinkerforge/bricklet_co2.rb', line 120

def get_co2_concentration_callback_threshold
  check_validity

  send_request FUNCTION_GET_CO2_CONCENTRATION_CALLBACK_THRESHOLD, [], '', 13, 'k S S'
end

#get_debounce_period ⇒ Object

Returns the debounce period as set by BrickletCO2#set_debounce_period.



142
143
144
145
146
 
# File 'lib/tinkerforge/bricklet_co2.rb', line 142

def get_debounce_period
  check_validity

  send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 12, 'L'
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|



158
159
160
 
# File 'lib/tinkerforge/bricklet_co2.rb', line 158

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

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



163
164
165
166
 
# File 'lib/tinkerforge/bricklet_co2.rb', line 163

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

#set_co2_concentration_callback_period(period) ⇒ Object

Sets the period with which the CALLBACK_CO2_CONCENTRATION callback is triggered periodically. A value of 0 turns the callback off.

The CALLBACK_CO2_CONCENTRATION callback is only triggered if the CO2 concentration has changed since the last triggering.



89
90
91
92
93
 
# File 'lib/tinkerforge/bricklet_co2.rb', line 89

def set_co2_concentration_callback_period(period)
  check_validity

  send_request FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_PERIOD, [period], 'L', 8, ''
end

#set_co2_concentration_callback_threshold(option, min, max) ⇒ Object

Sets the thresholds for the CALLBACK_CO2_CONCENTRATION_REACHED callback.

The following options are possible:

"Option", "Description"

"'x'",    "Callback is turned off"
"'o'",    "Callback is triggered when the CO2 concentration is *outside* the min and max values"
"'i'",    "Callback is triggered when the CO2 concentration is *inside* the min and max values"
"'<'",    "Callback is triggered when the CO2 concentration is smaller than the min value (max is ignored)"
"'>'",    "Callback is triggered when the CO2 concentration is greater than the min value (max is ignored)"



113
114
115
116
117
 
# File 'lib/tinkerforge/bricklet_co2.rb', line 113

def set_co2_concentration_callback_threshold(option, min, max)
  check_validity

  send_request FUNCTION_SET_CO2_CONCENTRATION_CALLBACK_THRESHOLD, [option, min, max], 'k S S', 8, ''
end

#set_debounce_period(debounce) ⇒ Object

Sets the period with which the threshold callbacks

  • CALLBACK_CO2_CONCENTRATION_REACHED,

are triggered, if the thresholds

  • BrickletCO2#set_co2_concentration_callback_threshold,

keep being reached.



135
136
137
138
139
 
# File 'lib/tinkerforge/bricklet_co2.rb', line 135

def set_debounce_period(debounce)
  check_validity

  send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, ''
end