Ruby - Particulate Matter Bricklet

This is the description of the Ruby API bindings for the Particulate Matter Bricklet. General information and technical specifications for the Particulate Matter 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
26
27
28
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_particulate_matter'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Particulate Matter Bricklet

ipcon = IPConnection.new # Create IP connection
pm = BrickletParticulateMatter.new UID, ipcon # Create device object

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

# Get current PM concentration as [pm10, pm25, pm100]
pm_concentration = pm.get_pm_concentration

puts "PM 1.0: #{pm_concentration[0]} µg/m³"
puts "PM 2.5: #{pm_concentration[1]} µg/m³"
puts "PM 10.0: #{pm_concentration[2]} µ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
32
33
#!/usr/bin/env ruby
# -*- ruby encoding: utf-8 -*-

require 'tinkerforge/ip_connection'
require 'tinkerforge/bricklet_particulate_matter'

include Tinkerforge

HOST = 'localhost'
PORT = 4223
UID = 'XYZ' # Change XYZ to the UID of your Particulate Matter Bricklet

ipcon = IPConnection.new # Create IP connection
pm = BrickletParticulateMatter.new UID, ipcon # Create device object

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

# Register PM concentration callback
pm.register_callback(BrickletParticulateMatter::CALLBACK_PM_CONCENTRATION) do |pm10, pm25,
                                                                               pm100|
  puts "PM 1.0: #{pm10} µg/m³"
  puts "PM 2.5: #{pm25} µg/m³"
  puts "PM 10.0: #{pm100} µg/m³"
  puts ''
end

# Set period for PM concentration callback to 1s (1000ms)
pm.set_pm_concentration_callback_configuration 1000, false

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

API

All methods listed below are thread-safe.

Basic Functions

BrickletParticulateMatter::new(uid, ipcon) → particulate_matter
Parameters:
  • uid -- str
  • ipcon -- IPConnection

Creates an object with the unique device ID uid:

particulate_matter = BrickletParticulateMatter.new 'YOUR_DEVICE_UID', ipcon

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

BrickletParticulateMatter#get_pm_concentration → [int, int, int]

Returns the particulate matter concentration in µg/m³, broken down as:

  • PM1.0,
  • PM2.5 and
  • PM10.0.

If the sensor is disabled (see #set_enable) then the last known good values from the sensor are returned.

The returned array has the values pm10, pm25 and pm100.

BrickletParticulateMatter#get_pm_count → [int, int, int, int, int, int]

Returns the number of particulates in 100 ml of air, broken down by their diameter:

  • greater 0.3µm,
  • greater 0.5µm,
  • greater 1.0µm,
  • greater 2.5µm,
  • greater 5.0µm and
  • greater 10.0µm.

If the sensor is disabled (see #set_enable) then the last known good value from the sensor is returned.

The returned array has the values greater03um, greater05um, greater10um, greater25um, greater50um and greater100um.

Advanced Functions

BrickletParticulateMatter#set_enable(enable) → nil
Parameters:enable -- bool

Enables/Disables the fan and the laser diode of the sensors. The sensor is enabled by default.

The sensor takes about 30 seconds after it is enabled to settle and produce stable values.

The laser diode has a lifetime of about 8000 hours. If you want to measure in an interval with a long idle time (e.g. hourly) you should turn the laser diode off between the measurements.

BrickletParticulateMatter#get_enable → bool

Returns the state of the sensor as set by #set_enable.

BrickletParticulateMatter#get_sensor_info → [int, int, int, int]

Returns information about the sensor:

  • the sensor version number,
  • the last error code reported by the sensor (0 means no error) and
  • the number of framing and checksum errors that occurred in the communication with the sensor.

The returned array has the values sensor_version, last_error_code, framing_error_count and checksum_error_count.

BrickletParticulateMatter#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.

BrickletParticulateMatter#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.

BrickletParticulateMatter#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:

  • BrickletParticulateMatter::FUNCTION_SET_ENABLE = 3
  • BrickletParticulateMatter::FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION = 6
  • BrickletParticulateMatter::FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION = 8
  • BrickletParticulateMatter::FUNCTION_SET_WRITE_FIRMWARE_POINTER = 237
  • BrickletParticulateMatter::FUNCTION_SET_STATUS_LED_CONFIG = 239
  • BrickletParticulateMatter::FUNCTION_RESET = 243
  • BrickletParticulateMatter::FUNCTION_WRITE_UID = 248
BrickletParticulateMatter#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.

BrickletParticulateMatter#get_spitfp_error_count → [int, int, int, int]

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.

The returned array has the values error_count_ack_checksum, error_count_message_checksum, error_count_frame and error_count_overflow.

BrickletParticulateMatter#set_bootloader_mode(mode) → int
Parameters:mode -- int

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.

The following constants are available for this function:

  • BrickletParticulateMatter::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletParticulateMatter::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletParticulateMatter::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletParticulateMatter::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletParticulateMatter::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
  • BrickletParticulateMatter::BOOTLOADER_STATUS_OK = 0
  • BrickletParticulateMatter::BOOTLOADER_STATUS_INVALID_MODE = 1
  • BrickletParticulateMatter::BOOTLOADER_STATUS_NO_CHANGE = 2
  • BrickletParticulateMatter::BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT = 3
  • BrickletParticulateMatter::BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT = 4
  • BrickletParticulateMatter::BOOTLOADER_STATUS_CRC_MISMATCH = 5
BrickletParticulateMatter#get_bootloader_mode → int

Returns the current bootloader mode, see #set_bootloader_mode.

The following constants are available for this function:

  • BrickletParticulateMatter::BOOTLOADER_MODE_BOOTLOADER = 0
  • BrickletParticulateMatter::BOOTLOADER_MODE_FIRMWARE = 1
  • BrickletParticulateMatter::BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT = 2
  • BrickletParticulateMatter::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT = 3
  • BrickletParticulateMatter::BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT = 4
BrickletParticulateMatter#set_write_firmware_pointer(pointer) → nil
Parameters:pointer -- int

Sets the firmware pointer for #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.

BrickletParticulateMatter#write_firmware(data) → int
Parameters:data -- [int, int, ..61x.., int]

Writes 64 Bytes of firmware at the position as written by #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.

BrickletParticulateMatter#set_status_led_config(config) → nil
Parameters:config -- int

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.

The following constants are available for this function:

  • BrickletParticulateMatter::STATUS_LED_CONFIG_OFF = 0
  • BrickletParticulateMatter::STATUS_LED_CONFIG_ON = 1
  • BrickletParticulateMatter::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletParticulateMatter::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletParticulateMatter#get_status_led_config → int

Returns the configuration as set by #set_status_led_config

The following constants are available for this function:

  • BrickletParticulateMatter::STATUS_LED_CONFIG_OFF = 0
  • BrickletParticulateMatter::STATUS_LED_CONFIG_ON = 1
  • BrickletParticulateMatter::STATUS_LED_CONFIG_SHOW_HEARTBEAT = 2
  • BrickletParticulateMatter::STATUS_LED_CONFIG_SHOW_STATUS = 3
BrickletParticulateMatter#get_chip_temperature → int

Returns the temperature in °C 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.

BrickletParticulateMatter#reset → nil

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!

BrickletParticulateMatter#write_uid(uid) → nil
Parameters:uid -- int

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.

BrickletParticulateMatter#read_uid → int

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

BrickletParticulateMatter#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

BrickletParticulateMatter#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.

BrickletParticulateMatter#set_pm_concentration_callback_configuration(period, value_has_to_change) → nil
Parameters:
  • period -- int
  • value_has_to_change -- bool

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

BrickletParticulateMatter#get_pm_concentration_callback_configuration → [int, bool]

Returns the callback configuration as set by #set_pm_concentration_callback_configuration.

The returned array has the values period and value_has_to_change.

BrickletParticulateMatter#set_pm_count_callback_configuration(period, value_has_to_change) → nil
Parameters:
  • period -- int
  • value_has_to_change -- bool

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

If the value has to change-parameter is set to true, the callback is only triggered after the value has changed. If the value didn't change within the period, the callback is triggered immediately on change.

If it is set to false, the callback is continuously triggered with the period, independent of the value.

The default value is (0, false).

BrickletParticulateMatter#get_pm_count_callback_configuration → [int, bool]

Returns the callback configuration as set by #set_pm_count_callback_configuration.

The returned array has the values period and value_has_to_change.

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:

particulate_matter.register_callback BrickletParticulateMatter::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.

BrickletParticulateMatter::CALLBACK_PM_CONCENTRATION
Parameters:
  • pm10 -- int
  • pm25 -- int
  • pm100 -- int

This callback is triggered periodically according to the configuration set by #set_pm_concentration_callback_configuration.

The parameters are the same as #get_pm_concentration.

BrickletParticulateMatter::CALLBACK_PM_COUNT
Parameters:
  • greater03um -- int
  • greater05um -- int
  • greater10um -- int
  • greater25um -- int
  • greater50um -- int
  • greater100um -- int

This callback is triggered periodically according to the configuration set by #set_pm_count_callback_configuration.

The parameters are the same as #get_pm_count.

Constants

BrickletParticulateMatter::DEVICE_IDENTIFIER

This constant is used to identify a Particulate Matter 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.

BrickletParticulateMatter::DEVICE_DISPLAY_NAME

This constant represents the human readable name of a Particulate Matter Bricklet.