Ruby - Dust Detector Bricklet

This is the description of the Ruby API bindings for the Dust Detector Bricklet. General information and technical specifications for the Dust Detector Bricklet are summarized in its hardware description.

An installation guide for the Ruby API bindings is part of their general description.

Examples

The example code below is Public Domain (CC0 1.0).

Simple

Download (example_simple.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_dust_detector'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Dust Detector Bricklet

ipcon = IPConnection.new # Create IP connection
dd = BrickletDustDetector.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get current dust density
dust_density = dd.get_dust_density
puts "Dust Density: #{dust_density} µg/m³"

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Callback

Download (example_callback.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_dust_detector'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Dust Detector Bricklet

ipcon = IPConnection.new # Create IP connection
dd = BrickletDustDetector.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Register dust density callback
dd.register_callback(BrickletDustDetector::CALLBACK_DUST_DENSITY) do |dust_density|
  puts "Dust Density: #{dust_density} µg/m³"
end

# Set period for dust density callback to 1s (1000ms)
# Note: The dust density callback is only called every second
#       if the dust density has changed since the last call!
dd.set_dust_density_callback_period 1000

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

Threshold

Download (example_threshold.rb)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_dust_detector'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Dust Detector Bricklet

ipcon = IPConnection.new # Create IP connection
dd = BrickletDustDetector.new UID, ipcon # Create device object

ipcon.connect HOST, PORT # Connect to brickd
# Don't use device before ipcon is connected

# Get threshold callbacks with a debounce time of 10 seconds (10000ms)
dd.set_debounce_period 10000

# Register dust density reached callback
dd.register_callback(BrickletDustDetector::CALLBACK_DUST_DENSITY_REACHED) do |dust_density|
  puts "Dust Density: #{dust_density} µg/m³"
end

# Configure threshold for dust density "greater than 10 µg/m³"
dd.set_dust_density_callback_threshold '>', 10, 0

puts 'Press key to exit'
$stdin.gets
ipcon.disconnect

API

All methods listed below are thread-safe.

Basic Functions

BrickletDustDetector::new(uid, ipcon) → dust_detector
Parameters:
  • uid -- str
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

dust_detector = BrickletDustDetector.new 'YOUR_DEVICE_UID', ipcon

This object can then be used after the IP Connection is connected (see examples above).

BrickletDustDetector#get_dust_density → int

Returns the dust density in µg/m³.

If you want to get the dust density periodically, it is recommended to use the ::CALLBACK_DUST_DENSITY callback and set the period with #set_dust_density_callback_period.

Advanced Functions

BrickletDustDetector#set_moving_average(average) → nil
Parameters:average -- int

Sets the length of a moving averaging for the dust_density.

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

The range for the averaging is 0-100.

The default value is 100.

BrickletDustDetector#get_moving_average → int

Returns the length moving average as set by #set_moving_average.

BrickletDustDetector#get_api_version → [int, int, int]

Returns the version of the API definition (major, minor, revision) implemented by this API bindings. This is neither the release version of this API bindings nor does it tell you anything about the represented Brick or Bricklet.

BrickletDustDetector#get_response_expected(function_id) → bool
Parameters:function_id -- int

Returns the response expected flag for the function specified by the function ID parameter. It is true if the function is expected to send a response, false otherwise.

For getter functions this is enabled by default and cannot be disabled, because those functions will always send a response. For callback configuration functions it is enabled by default too, but can be disabled by #set_response_expected. For setter functions it is disabled by default and can be enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

See #set_response_expected for the list of function ID constants available for this function.

BrickletDustDetector#set_response_expected(function_id, response_expected) → nil
Parameters:
  • function_id -- int
  • response_expected -- bool

Changes the response expected flag of the function specified by the function ID parameter. This flag can only be changed for setter (default value: false) and callback configuration functions (default value: true). For getter functions it is always enabled.

Enabling the response expected flag for a setter function allows to detect timeouts and other error conditions calls of this setter as well. The device will then send a response for this purpose. If this flag is disabled for a setter function then no response is send and errors are silently ignored, because they cannot be detected.

The following function ID constants are available for this function:

  • BrickletDustDetector::FUNCTION_SET_DUST_DENSITY_CALLBACK_PERIOD = 2
  • BrickletDustDetector::FUNCTION_SET_DUST_DENSITY_CALLBACK_THRESHOLD = 4
  • BrickletDustDetector::FUNCTION_SET_DEBOUNCE_PERIOD = 6
  • BrickletDustDetector::FUNCTION_SET_MOVING_AVERAGE = 10
BrickletDustDetector#set_response_expected_all(response_expected) → nil
Parameters:response_expected -- bool

Changes the response expected flag for all setter and callback configuration functions of this device at once.

BrickletDustDetector#get_identity → [str, str, str, [int, int, int], [int, int, int], int]

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' or 'd'.

The device identifier numbers can be found here. There is also a constant for the device identifier of this Bricklet.

The returned array has the values uid, connected_uid, position, hardware_version, firmware_version and device_identifier.

Callback Configuration Functions

BrickletDustDetector#register_callback(callback_id) { |param [, ...]| block } → nil
Parameters:callback_id -- int

Registers the given block with the given callback_id.

The available callback IDs with corresponding function signatures are listed below.

BrickletDustDetector#set_dust_density_callback_period(period) → nil
Parameters:period -- int

Sets the period in ms with which the ::CALLBACK_DUST_DENSITY callback is triggered periodically. A value of 0 turns the callback off.

The ::CALLBACK_DUST_DENSITY callback is only triggered if the dust density has changed since the last triggering.

The default value is 0.

BrickletDustDetector#get_dust_density_callback_period → int

Returns the period as set by #set_dust_density_callback_period.

BrickletDustDetector#set_dust_density_callback_threshold(option, min, max) → nil
Parameters:
  • option -- str
  • min -- int
  • max -- int

Sets the thresholds for the ::CALLBACK_DUST_DENSITY_REACHED callback.

The following options are possible:

Option Description
'x' Callback is turned off
'o' Callback is triggered when the dust density value is outside the min and max values
'i' Callback is triggered when the dust density value is inside the min and max values
'<' Callback is triggered when the dust density value is smaller than the min value (max is ignored)
'>' Callback is triggered when the dust density value is greater than the min value (max is ignored)

The default value is ('x', 0, 0).

The following constants are available for this function:

  • BrickletDustDetector::THRESHOLD_OPTION_OFF = 'x'
  • BrickletDustDetector::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDustDetector::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDustDetector::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDustDetector::THRESHOLD_OPTION_GREATER = '>'
BrickletDustDetector#get_dust_density_callback_threshold → [str, int, int]

Returns the threshold as set by #set_dust_density_callback_threshold.

The following constants are available for this function:

  • BrickletDustDetector::THRESHOLD_OPTION_OFF = 'x'
  • BrickletDustDetector::THRESHOLD_OPTION_OUTSIDE = 'o'
  • BrickletDustDetector::THRESHOLD_OPTION_INSIDE = 'i'
  • BrickletDustDetector::THRESHOLD_OPTION_SMALLER = '<'
  • BrickletDustDetector::THRESHOLD_OPTION_GREATER = '>'

The returned array has the values option, min and max.

BrickletDustDetector#set_debounce_period(debounce) → nil
Parameters:debounce -- int

Sets the period in ms with which the threshold callback

is triggered, if the threshold

keeps being reached.

The default value is 100.

BrickletDustDetector#get_debounce_period → int

Returns the debounce period as set by #set_debounce_period.

Callbacks

Callbacks can be registered to receive time critical or recurring data from the device. The registration is done with the #register_callback function of the device object. The first parameter is the callback ID and the second parameter is a block:

dust_detector.register_callback BrickletDustDetector::CALLBACK_EXAMPLE, do |param|
  puts "#{param}"
end

The available constants with inherent number and type of parameters are described below.

Note

Using callbacks for recurring events is always preferred compared to using getters. It will use less USB bandwidth and the latency will be a lot better, since there is no round trip time.

BrickletDustDetector::CALLBACK_DUST_DENSITY
Parameters:dust_density -- int

This callback is triggered periodically with the period that is set by #set_dust_density_callback_period. The parameter is the dust density of the sensor.

Der ::CALLBACK_DUST_DENSITY callback is only triggered if the dust density value has changed since the last triggering.

BrickletDustDetector::CALLBACK_DUST_DENSITY_REACHED
Parameters:dust_density -- int

This callback is triggered when the threshold as set by #set_dust_density_callback_threshold is reached. The parameter is the dust density of the sensor.

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

Constants

BrickletDustDetector::DEVICE_IDENTIFIER

This constant is used to identify a Dust Detector Bricklet.

The #get_identity() function and the ::CALLBACK_ENUMERATE callback of the IP Connection have a device_identifier parameter to specify the Brick's or Bricklet's type.

BrickletDustDetector::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Dust Detector Bricklet.