Class: Tinkerforge::BrickletMotionDetectorV2

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

Overview

Passive infrared (PIR) motion sensor with 12m range and dimmable backlight

Constant Summary collapse

DEVICE_IDENTIFIER =

:nodoc:

292
DEVICE_DISPLAY_NAME =

:nodoc:

'Motion Detector Bricklet 2.0'
CALLBACK_MOTION_DETECTED =

This callback is called after a motion was detected.

6
CALLBACK_DETECTION_CYCLE_ENDED =

This callback is called when the detection cycle ended. When this callback is called, a new motion can be detected again after approximately 2 seconds.

7
FUNCTION_GET_MOTION_DETECTED =

:nodoc:

1
FUNCTION_SET_SENSITIVITY =

:nodoc:

2
FUNCTION_GET_SENSITIVITY =

:nodoc:

3
FUNCTION_SET_INDICATOR =

:nodoc:

4
FUNCTION_GET_INDICATOR =

:nodoc:

5
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
MOTION_NOT_DETECTED =

:nodoc:

0
MOTION_DETECTED =

:nodoc:

1
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) ⇒ BrickletMotionDetectorV2

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 66

def initialize(uid, ipcon)
  super uid, ipcon, DEVICE_IDENTIFIER, DEVICE_DISPLAY_NAME

  @api_version = [2, 0, 0]

  @response_expected[FUNCTION_GET_MOTION_DETECTED] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_SENSITIVITY] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_SENSITIVITY] = RESPONSE_EXPECTED_ALWAYS_TRUE
  @response_expected[FUNCTION_SET_INDICATOR] = RESPONSE_EXPECTED_FALSE
  @response_expected[FUNCTION_GET_INDICATOR] = 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_MOTION_DETECTED] = [8, '']
  @callback_formats[CALLBACK_DETECTION_CYCLE_ENDED] = [8, '']

  @ipcon.add_device self
end

Instance Method Details

#get_bootloader_mode ⇒ Object

Returns the current bootloader mode, see BrickletMotionDetectorV2#set_bootloader_mode.



177
178
179
180
181
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 177

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.



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

def get_chip_temperature
  check_validity

  send_request FUNCTION_GET_CHIP_TEMPERATURE, [], '', 10, 's'
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|



282
283
284
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 282

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

#get_indicator ⇒ Object

Returns the indicator configuration as set by BrickletMotionDetectorV2#set_indicator.



138
139
140
141
142
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 138

def get_indicator
  check_validity

  send_request FUNCTION_GET_INDICATOR, [], '', 11, 'C C C'
end

#get_motion_detected ⇒ Object

Returns 1 if a motion was detected. It returns 1 approx. for 1.8 seconds until the sensor checks for a new movement.

There is also a blue LED on the Bricklet that is on as long as the Bricklet is in the “motion detected” state.



100
101
102
103
104
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 100

def get_motion_detected
  check_validity

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

#get_sensitivity ⇒ Object

Returns the sensitivity as set by BrickletMotionDetectorV2#set_sensitivity.



121
122
123
124
125
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 121

def get_sensitivity
  check_validity

  send_request FUNCTION_GET_SENSITIVITY, [], '', 9, '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.



155
156
157
158
159
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 155

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 BrickletMotionDetectorV2#set_status_led_config



223
224
225
226
227
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 223

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.



266
267
268
269
270
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 266

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.



287
288
289
290
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 287

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!



247
248
249
250
251
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 247

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.



170
171
172
173
174
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 170

def set_bootloader_mode(mode)
  check_validity

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

#set_indicator(top_left, top_right, bottom) ⇒ Object

Sets the blue backlight of the fresnel lens. The backlight consists of three LEDs. The brightness of each LED can be controlled with a 8-bit value (0-255). A value of 0 turns the LED off and a value of 255 turns the LED to full brightness.



131
132
133
134
135
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 131

def set_indicator(top_left, top_right, bottom)
  check_validity

  send_request FUNCTION_SET_INDICATOR, [top_left, top_right, bottom], 'C C C', 8, ''
end

#set_sensitivity(sensitivity) ⇒ Object

Sets the sensitivity of the PIR sensor. At full sensitivity (100), the Bricklet can detect motion in a range of approximately 12m.

The actual range depends on many things in the environment (e.g. reflections) and the size of the object to be detected. While a big person might be detected in a range of 10m a cat may only be detected at 2m distance with the same setting.

So you will have to find a good sensitivity for your application by trial and error.



114
115
116
117
118
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 114

def set_sensitivity(sensitivity)
  check_validity

  send_request FUNCTION_SET_SENSITIVITY, [sensitivity], 'C', 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.



216
217
218
219
220
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 216

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



189
190
191
192
193
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 189

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



203
204
205
206
207
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 203

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.



258
259
260
261
262
 
# File 'lib/tinkerforge/bricklet_motion_detector_v2.rb', line 258

def write_uid(uid)
  check_validity

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