Class: Tinkerforge::BrickletParticulateMatter

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

Overview

Measures Particulate Matter concentration (PM1.0, PM2.5 and PM10)

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

2110
DEVICE_DISPLAY_NAME =

:nodoc:

'Particulate Matter Bricklet'
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.

10
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.

11
FUNCTION_GET_PM_CONCENTRATION =

:nodoc:

1
FUNCTION_GET_PM_COUNT =

:nodoc:

2
FUNCTION_SET_ENABLE =

:nodoc:

3
FUNCTION_GET_ENABLE =

:nodoc:

4
FUNCTION_GET_SENSOR_INFO =

:nodoc:

5
FUNCTION_SET_PM_CONCENTRATION_CALLBACK_CONFIGURATION =

:nodoc:

6
FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION =

:nodoc:

7
FUNCTION_SET_PM_COUNT_CALLBACK_CONFIGURATION =

:nodoc:

8
FUNCTION_GET_PM_COUNT_CALLBACK_CONFIGURATION =

:nodoc:

9
FUNCTION_GET_SPITFP_ERROR_COUNT =

:nodoc:

234
FUNCTION_SET_BOOTLOADER_MODE =

:nodoc:

235
FUNCTION_GET_BOOTLOADER_MODE =

:nodoc:

236
FUNCTION_SET_WRITE_FIRMWARE_POINTER =

:nodoc:

237
FUNCTION_WRITE_FIRMWARE =

:nodoc:

238
FUNCTION_SET_STATUS_LED_CONFIG =

:nodoc:

239
FUNCTION_GET_STATUS_LED_CONFIG =

:nodoc:

240
FUNCTION_GET_CHIP_TEMPERATURE =

:nodoc:

242
FUNCTION_RESET =

:nodoc:

243
FUNCTION_WRITE_UID =

:nodoc:

248
FUNCTION_READ_UID =

:nodoc:

249
FUNCTION_GET_IDENTITY =

:nodoc:

255
BOOTLOADER_MODE_BOOTLOADER =

:nodoc:

0
BOOTLOADER_MODE_FIRMWARE =

:nodoc:

1
BOOTLOADER_MODE_BOOTLOADER_WAIT_FOR_REBOOT =

:nodoc:

2
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_REBOOT =

:nodoc:

3
BOOTLOADER_MODE_FIRMWARE_WAIT_FOR_ERASE_AND_REBOOT =

:nodoc:

4
BOOTLOADER_STATUS_OK =

:nodoc:

0
BOOTLOADER_STATUS_INVALID_MODE =

:nodoc:

1
BOOTLOADER_STATUS_NO_CHANGE =

:nodoc:

2
BOOTLOADER_STATUS_ENTRY_FUNCTION_NOT_PRESENT =

:nodoc:

3
BOOTLOADER_STATUS_DEVICE_IDENTIFIER_INCORRECT =

:nodoc:

4
BOOTLOADER_STATUS_CRC_MISMATCH =

:nodoc:

5
STATUS_LED_CONFIG_OFF =

:nodoc:

0
STATUS_LED_CONFIG_ON =

:nodoc:

1
STATUS_LED_CONFIG_SHOW_HEARTBEAT =

:nodoc:

2
STATUS_LED_CONFIG_SHOW_STATUS =

:nodoc:

3

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) ⇒ BrickletParticulateMatter

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 72

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

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletParticulateMatter#set_bootloader_mode.



257
258
259
260
261
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 257

def get_bootloader_mode
  check_validity

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

#get_chip_temperature ⇒ Object

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.



315
316
317
318
319
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 315

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
end

#get_enable ⇒ Object

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



160
161
162
163
164
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 160

def get_enable
  check_validity

  send_request FUNCTION_GET_ENABLE, [], '', 9, '?'
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|



362
363
364
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 362

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

#get_pm_concentration ⇒ Object

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.



117
118
119
120
121
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 117

def get_pm_concentration
  check_validity

  send_request FUNCTION_GET_PM_CONCENTRATION, [], '', 14, 'S S S'
end

#get_pm_concentration_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletParticulateMatter#set_pm_concentration_callback_configuration.



195
196
197
198
199
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 195

def get_pm_concentration_callback_configuration
  check_validity

  send_request FUNCTION_GET_PM_CONCENTRATION_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
end

#get_pm_count ⇒ Object

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.



139
140
141
142
143
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 139

def get_pm_count
  check_validity

  send_request FUNCTION_GET_PM_COUNT, [], '', 20, 'S S S S S S'
end

#get_pm_count_callback_configuration ⇒ Object

Returns the callback configuration as set by BrickletParticulateMatter#set_pm_count_callback_configuration.



218
219
220
221
222
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 218

def get_pm_count_callback_configuration
  check_validity

  send_request FUNCTION_GET_PM_COUNT_CALLBACK_CONFIGURATION, [], '', 13, 'L ?'
end

#get_sensor_info ⇒ Object

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.



172
173
174
175
176
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 172

def get_sensor_info
  check_validity

  send_request FUNCTION_GET_SENSOR_INFO, [], '', 12, 'C C C C'
end

#get_spitfp_error_count ⇒ Object

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.



235
236
237
238
239
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 235

def get_spitfp_error_count
  check_validity

  send_request FUNCTION_GET_SPITFP_ERROR_COUNT, [], '', 24, 'L L L L'
end

#get_status_led_config ⇒ Object

Returns the configuration as set by BrickletParticulateMatter#set_status_led_config



303
304
305
306
307
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 303

def get_status_led_config
  check_validity

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

#read_uid ⇒ Object

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



346
347
348
349
350
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 346

def read_uid
  check_validity

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

#register_callback(id, &block) ⇒ Object

Registers a callback with ID id to the block block.



367
368
369
370
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 367

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

#reset ⇒ Object

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!



327
328
329
330
331
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 327

def reset
  check_validity

  send_request FUNCTION_RESET, [], '', 8, ''
end

#set_bootloader_mode(mode) ⇒ Object

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.



250
251
252
253
254
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 250

def set_bootloader_mode(mode)
  check_validity

  send_request FUNCTION_SET_BOOTLOADER_MODE, [mode], 'C', 9, 'C'
end

#set_enable(enable) ⇒ Object

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.



153
154
155
156
157
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 153

def set_enable(enable)
  check_validity

  send_request FUNCTION_SET_ENABLE, [enable], '?', 8, ''
end

#set_pm_concentration_callback_configuration(period, value_has_to_change) ⇒ Object

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.



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

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

#set_pm_count_callback_configuration(period, value_has_to_change) ⇒ Object

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.



210
211
212
213
214
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 210

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

#set_status_led_config(config) ⇒ Object

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.



296
297
298
299
300
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 296

def set_status_led_config(config)
  check_validity

  send_request FUNCTION_SET_STATUS_LED_CONFIG, [config], 'C', 8, ''
end

#set_write_firmware_pointer(pointer) ⇒ Object

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.



269
270
271
272
273
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 269

def set_write_firmware_pointer(pointer)
  check_validity

  send_request FUNCTION_SET_WRITE_FIRMWARE_POINTER, [pointer], 'L', 8, ''
end

#write_firmware(data) ⇒ Object

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.



283
284
285
286
287
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 283

def write_firmware(data)
  check_validity

  send_request FUNCTION_WRITE_FIRMWARE, [data], 'C64', 9, 'C'
end

#write_uid(uid) ⇒ Object

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.



338
339
340
341
342
 
# File 'lib/tinkerforge/bricklet_particulate_matter.rb', line 338

def write_uid(uid)
  check_validity

  send_request FUNCTION_WRITE_UID, [uid], 'L', 8, ''
end