Class: Tinkerforge::BrickletMoisture

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

Overview

Measures soil moisture

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

232
DEVICE_DISPLAY_NAME =

:nodoc:

'Moisture Bricklet'
CALLBACK_MOISTURE =

This callback is triggered periodically with the period that is set by BrickletMoisture#set_moisture_callback_period. The parameter is the moisture value of the sensor.

The CALLBACK_MOISTURE callback is only triggered if the moisture value has changed since the last triggering.

8
CALLBACK_MOISTURE_REACHED =

This callback is triggered when the threshold as set by BrickletMoisture#set_moisture_callback_threshold is reached. The parameter is the moisture value of the sensor.

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

9
FUNCTION_GET_MOISTURE_VALUE =

:nodoc:

1
FUNCTION_SET_MOISTURE_CALLBACK_PERIOD =

:nodoc:

2
FUNCTION_GET_MOISTURE_CALLBACK_PERIOD =

:nodoc:

3
FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD =

:nodoc:

4
FUNCTION_GET_MOISTURE_CALLBACK_THRESHOLD =

:nodoc:

5
FUNCTION_SET_DEBOUNCE_PERIOD =

:nodoc:

6
FUNCTION_GET_DEBOUNCE_PERIOD =

:nodoc:

7
FUNCTION_SET_MOVING_AVERAGE =

:nodoc:

10
FUNCTION_GET_MOVING_AVERAGE =

:nodoc:

11
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) ⇒ BrickletMoisture

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/tinkerforge/bricklet_moisture.rb', line 55

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

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_MOISTURE_VALUE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_MOISTURE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_MOISTURE_CALLBACK_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_MOISTURE_CALLBACK_THRESHOLD] = RESPONSE_EXPECTED_TRUE
  @response_expected[FUNCTION_GET_MOISTURE_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_SET_MOVING_AVERAGE] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_MOVING_AVERAGE] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE

  @callback_formats[CALLBACK_MOISTURE] = [10, 'S']
  @callback_formats[CALLBACK_MOISTURE_REACHED] = [10, 'S']

  @ipcon.add_device self
end

Instance Method Details

#get_debounce_period ⇒ Object

Returns the debounce period as set by BrickletMoisture#set_debounce_period.



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

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|



182
183
184
 
# File 'lib/tinkerforge/bricklet_moisture.rb', line 182

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

#get_moisture_callback_period ⇒ Object

Returns the period as set by BrickletMoisture#set_moisture_callback_period.



102
103
104
105
106
 
# File 'lib/tinkerforge/bricklet_moisture.rb', line 102

def get_moisture_callback_period
  check_validity

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

#get_moisture_callback_threshold ⇒ Object

Returns the threshold as set by BrickletMoisture#set_moisture_callback_threshold.



126
127
128
129
130
 
# File 'lib/tinkerforge/bricklet_moisture.rb', line 126

def get_moisture_callback_threshold
  check_validity

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

#get_moisture_value ⇒ Object

Returns the current moisture value. A small value corresponds to little moisture, a big value corresponds to much moisture.

If you want to get the moisture value periodically, it is recommended to use the CALLBACK_MOISTURE callback and set the period with BrickletMoisture#set_moisture_callback_period.



84
85
86
87
88
 
# File 'lib/tinkerforge/bricklet_moisture.rb', line 84

def get_moisture_value
  check_validity

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

#get_moving_average ⇒ Object

Returns the length moving average as set by BrickletMoisture#set_moving_average.



166
167
168
169
170
 
# File 'lib/tinkerforge/bricklet_moisture.rb', line 166

def get_moving_average
  check_validity

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

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



187
188
189
190
 
# File 'lib/tinkerforge/bricklet_moisture.rb', line 187

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

#set_debounce_period(debounce) ⇒ Object

Sets the period with which the threshold callback

  • CALLBACK_MOISTURE_REACHED

is triggered, if the threshold

  • BrickletMoisture#set_moisture_callback_threshold

keeps being reached.



141
142
143
144
145
 
# File 'lib/tinkerforge/bricklet_moisture.rb', line 141

def set_debounce_period(debounce)
  check_validity

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

#set_moisture_callback_period(period) ⇒ Object

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

The CALLBACK_MOISTURE callback is only triggered if the moisture value has changed since the last triggering.



95
96
97
98
99
 
# File 'lib/tinkerforge/bricklet_moisture.rb', line 95

def set_moisture_callback_period(period)
  check_validity

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

#set_moisture_callback_threshold(option, min, max) ⇒ Object

Sets the thresholds for the CALLBACK_MOISTURE_REACHED callback.

The following options are possible:

"Option", "Description"

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



119
120
121
122
123
 
# File 'lib/tinkerforge/bricklet_moisture.rb', line 119

def set_moisture_callback_threshold(option, min, max)
  check_validity

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

#set_moving_average(average) ⇒ Object

Sets the length of a ‘moving averaging <en.wikipedia.org/wiki/Moving_average>`__ for the moisture value.

Setting the length to 0 will turn the averaging completely off. With less averaging, there is more noise on the data.



159
160
161
162
163
 
# File 'lib/tinkerforge/bricklet_moisture.rb', line 159

def set_moving_average(average)
  check_validity

  send_request FUNCTION_SET_MOVING_AVERAGE, [average], 'C', 8, ''
end