class Tinkerforge::BrickletParticulateMatter
Measures Particulate Matter concentration (PM1.0, PM2.5 and PM10)
Constants
- CALLBACK_PM_CONCENTRATION
This callback is triggered periodically according to the configuration set by
BrickletParticulateMatter#set_pm_concentration_callback_configuration
.The parameters are the same as
BrickletParticulateMatter#get_pm_concentration
.- CALLBACK_PM_COUNT
This callback is triggered periodically according to the configuration set by
BrickletParticulateMatter#set_pm_count_callback_configuration
.The parameters are the same as
BrickletParticulateMatter#get_pm_count
.
Public Class Methods
Creates an object with the unique device ID uid
and adds it to the IP Connection ipcon
.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 71 def initialize(uid, ipcon) super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME @api_version = [2, 0, 0] @response_expected[FUNCTION_GET_PM_CONCENTRATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_PM_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_ENABLE] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_ENABLE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_SENSOR_INFO] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_TRUE @response_expected[FUNCTION_GET_PM_COUNT_CALLBACK_CONFIGURATION] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_SPITFP_ERROR_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_BOOTLOADER_MODE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_WRITE_FIRMWARE_POINTER] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_WRITE_FIRMWARE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_SET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_GET_STATUS_LED_CONFIG] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_CHIP_TEMPERATURE] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_RESET] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_WRITE_UID] = RESPONSE_EXPECTED_FALSE @response_expected[FUNCTION_READ_UID] = RESPONSE_EXPECTED_ALWAYS_TRUE @response_expected[FUNCTION_GET_IDENTITY] = RESPONSE_EXPECTED_ALWAYS_TRUE @callback_formats[CALLBACK_PM_CONCENTRATION] = [14, 'S S S'] @callback_formats[CALLBACK_PM_COUNT] = [20, 'S S S S S S'] @ipcon.add_device self end
Public Instance Methods
Returns the current bootloader mode, see BrickletParticulateMatter#set_bootloader_mode
.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 256 def get_bootloader_mode check_validity send_request FUNCTION_GET_BOOTLOADER_MODE, [], '', 9, 'C' end
Returns the temperature 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.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 314 def get_chip_temperature check_validity send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's' end
Returns the state of the sensor as set by BrickletParticulateMatter#set_enable
.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 159 def get_enable check_validity send_request FUNCTION_GET_ENABLE, [], '', 9, '?' 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_particulate_matter.rb, line 361 def get_identity send_request FUNCTION_GET_IDENTITY, [], '', 33, 'Z8 Z8 k C3 C3 S' end
Returns the particulate matter concentration, broken down as:
-
PM\ :sub:`1.0`\ ,
-
PM\ :sub:`2.5`\ and
-
PM\ :sub:`10.0`\ .
If the sensor is disabled (see BrickletParticulateMatter#set_enable
) then the last known good values from the sensor are returned.
If you want to get the values periodically, it is recommended to use the CALLBACK_PM_CONCENTRATION
callback. You can set the callback configuration with BrickletParticulateMatter#set_pm_concentration_callback_configuration
.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 116 def get_pm_concentration check_validity send_request FUNCTION_GET_PM_CONCENTRATION, [], '', 14, 'S S S' end
Returns the callback configuration as set by BrickletParticulateMatter#set_pm_concentration_callback_configuration
.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 194 def get_pm_concentration_callback_configuration check_validity send_request FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION, [], '', 13, 'L ?' end
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 BrickletParticulateMatter#set_enable
) then the last known good value from the sensor is returned.
If you want to get the values periodically, it is recommended to use the CALLBACK_PM_COUNT
callback. You can set the callback configuration with BrickletParticulateMatter#set_pm_count_callback_configuration
.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 138 def get_pm_count check_validity send_request FUNCTION_GET_PM_COUNT, [], '', 20, 'S S S S S S' end
Returns the callback configuration as set by BrickletParticulateMatter#set_pm_count_callback_configuration
.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 217 def get_pm_count_callback_configuration check_validity send_request FUNCTION_GET_PM_COUNT_CALLBACK_CONFIGURATION, [], '', 13, 'L ?' end
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.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 171 def get_sensor_info check_validity send_request FUNCTION_GET_SENSOR_INFO, [], '', 12, 'C C C C' end
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.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 234 def get_spitfp_error_count check_validity send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L' end
Returns the configuration as set by BrickletParticulateMatter#set_status_led_config
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 302 def get_status_led_config check_validity send_request FUNCTION_GET_STATUS_LED_CONFIG, [], '', 9, 'C' end
Returns the current UID as an integer. Encode as Base58
to get the usual string version.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 345 def read_uid check_validity send_request FUNCTION_READ_UID, [], '', 12, 'L' end
Registers a callback with ID id
to the block block
.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 366 def register_callback(id, &block) callback = block @registered_callbacks[id] = callback end
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!
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 326 def reset check_validity send_request FUNCTION_RESET, [], '', 8, '' end
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.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 249 def set_bootloader_mode(mode) check_validity send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C' end
Enables/Disables the fan and the laser diode of the sensors.
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.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 152 def set_enable(enable) check_validity send_request FUNCTION_SET_ENABLE, [enable], '?', 8, '' end
The period 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.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 186 def set_pm_concentration_callback_configuration(period, value_has_to_change) check_validity send_request FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, '' end
The period 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.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 209 def set_pm_count_callback_configuration(period, value_has_to_change) check_validity send_request FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION, [period, value_has_to_change], 'L ?', 8, '' end
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.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 295 def set_status_led_config(config) check_validity send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, '' end
Sets the firmware pointer for BrickletParticulateMatter#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.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 268 def set_write_firmware_pointer(pointer) check_validity send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, '' end
Writes 64 Bytes of firmware at the position as written by BrickletParticulateMatter#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.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 282 def write_firmware(data) check_validity send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C' end
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.
# File lib/tinkerforge/bricklet_particulate_matter.rb, line 337 def write_uid(uid) check_validity send_request FUNCTION_WRITE_UID, [uid], 'L', 8, '' end