class Tinkerforge::BrickletMoisture
Measures soil moisture
Constants
- 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.- 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
.
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_moisture.rb, line 54 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
Public Instance Methods
Returns the debounce period as set by BrickletMoisture#set_debounce_period
.
# File lib/tinkerforge/bricklet_moisture.rb, line 147 def get_debounce_period check_validity send_request FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 12, 'L' end
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_moisture.rb, line 181 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
Returns the period as set by BrickletMoisture#set_moisture_callback_period
.
# File lib/tinkerforge/bricklet_moisture.rb, line 101 def get_moisture_callback_period check_validity send_request FUNCTION_GET_MOISTURE_CALLBACK_PERIOD, [], '', 12, 'L' end
Returns the threshold as set by BrickletMoisture#set_moisture_callback_threshold
.
# File lib/tinkerforge/bricklet_moisture.rb, line 125 def get_moisture_callback_threshold check_validity send_request FUNCTION_GET_MOISTURE_CALLBACK_THRESHOLD, [], '', 13, 'k S S' end
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
.
# File lib/tinkerforge/bricklet_moisture.rb, line 83 def get_moisture_value check_validity send_request FUNCTION_GET_MOISTURE_VALUE, [], '', 10, 'S' end
Returns the length moving average as set by BrickletMoisture#set_moving_average
.
# File lib/tinkerforge/bricklet_moisture.rb, line 165 def get_moving_average check_validity send_request FUNCTION_GET_MOVING_AVERAGE, [], '', 9, 'C' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_moisture.rb, line 186 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end
Sets the period with which the threshold callback
is triggered, if the threshold
keeps being reached.
# File lib/tinkerforge/bricklet_moisture.rb, line 140 def set_debounce_period(debounce) check_validity send_request FUNCTION_SET_DEBOUNCE_PERIOD, [debounce], 'L', 8, '' end
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.
# File lib/tinkerforge/bricklet_moisture.rb, line 94 def set_moisture_callback_period(period) check_validity send_request FUNCTION_SET_MOISTURE_CALLBACK_PERIOD, [period], 'L', 8, '' end
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)"
# File lib/tinkerforge/bricklet_moisture.rb, line 118 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