tinkerforge 2.1.11 → 2.1.12
Sign up to get free protection for your applications and to get access to all the features.
- data/lib/tinkerforge/brick_dc.rb +31 -9
- data/lib/tinkerforge/brick_imu.rb +62 -40
- data/lib/tinkerforge/brick_imu_v2.rb +70 -42
- data/lib/tinkerforge/brick_master.rb +47 -23
- data/lib/tinkerforge/brick_red.rb +3 -3
- data/lib/tinkerforge/brick_servo.rb +40 -18
- data/lib/tinkerforge/brick_silent_stepper.rb +829 -0
- data/lib/tinkerforge/brick_stepper.rb +47 -25
- data/lib/tinkerforge/bricklet_accelerometer.rb +11 -11
- data/lib/tinkerforge/bricklet_ambient_light.rb +12 -12
- data/lib/tinkerforge/bricklet_ambient_light_v2.rb +8 -8
- data/lib/tinkerforge/bricklet_analog_in.rb +18 -18
- data/lib/tinkerforge/bricklet_analog_in_v2.rb +15 -15
- data/lib/tinkerforge/bricklet_analog_out.rb +3 -3
- data/lib/tinkerforge/bricklet_analog_out_v2.rb +3 -3
- data/lib/tinkerforge/bricklet_barometer.rb +19 -19
- data/lib/tinkerforge/bricklet_can.rb +20 -7
- data/lib/tinkerforge/bricklet_co2.rb +14 -14
- data/lib/tinkerforge/bricklet_color.rb +19 -19
- data/lib/tinkerforge/bricklet_current12.rb +16 -16
- data/lib/tinkerforge/bricklet_current25.rb +15 -15
- data/lib/tinkerforge/bricklet_distance_ir.rb +14 -14
- data/lib/tinkerforge/bricklet_distance_us.rb +9 -9
- data/lib/tinkerforge/bricklet_dual_button.rb +5 -5
- data/lib/tinkerforge/bricklet_dual_relay.rb +13 -13
- data/lib/tinkerforge/bricklet_dust_detector.rb +11 -11
- data/lib/tinkerforge/bricklet_gps.rb +21 -21
- data/lib/tinkerforge/bricklet_hall_effect.rb +12 -10
- data/lib/tinkerforge/bricklet_humidity.rb +21 -21
- data/lib/tinkerforge/bricklet_industrial_analog_out.rb +3 -3
- data/lib/tinkerforge/bricklet_industrial_digital_in_4.rb +4 -4
- data/lib/tinkerforge/bricklet_industrial_digital_out_4.rb +4 -4
- data/lib/tinkerforge/bricklet_industrial_dual_0_20ma.rb +6 -6
- data/lib/tinkerforge/bricklet_industrial_dual_analog_in.rb +6 -6
- data/lib/tinkerforge/bricklet_industrial_quad_relay.rb +5 -5
- data/lib/tinkerforge/bricklet_io16.rb +5 -5
- data/lib/tinkerforge/bricklet_io4.rb +5 -5
- data/lib/tinkerforge/bricklet_joystick.rb +16 -16
- data/lib/tinkerforge/bricklet_laser_range_finder.rb +99 -30
- data/lib/tinkerforge/bricklet_lcd_16x2.rb +5 -5
- data/lib/tinkerforge/bricklet_lcd_20x4.rb +5 -5
- data/lib/tinkerforge/bricklet_led_strip.rb +3 -3
- data/lib/tinkerforge/bricklet_line.rb +12 -12
- data/lib/tinkerforge/bricklet_linear_poti.rb +21 -21
- data/lib/tinkerforge/bricklet_load_cell.rb +10 -10
- data/lib/tinkerforge/bricklet_moisture.rb +12 -12
- data/lib/tinkerforge/bricklet_motion_detector.rb +5 -5
- data/lib/tinkerforge/bricklet_multi_touch.rb +3 -3
- data/lib/tinkerforge/bricklet_nfc_rfid.rb +20 -20
- data/lib/tinkerforge/bricklet_oled_128x64.rb +7 -7
- data/lib/tinkerforge/bricklet_oled_64x48.rb +6 -6
- data/lib/tinkerforge/bricklet_piezo_buzzer.rb +4 -4
- data/lib/tinkerforge/bricklet_piezo_speaker.rb +5 -5
- data/lib/tinkerforge/bricklet_ptc.rb +21 -21
- data/lib/tinkerforge/bricklet_real_time_clock.rb +7 -7
- data/lib/tinkerforge/bricklet_remote_switch.rb +3 -3
- data/lib/tinkerforge/bricklet_rgb_led.rb +3 -3
- data/lib/tinkerforge/bricklet_rotary_encoder.rb +6 -6
- data/lib/tinkerforge/bricklet_rotary_poti.rb +23 -23
- data/lib/tinkerforge/bricklet_rs232.rb +19 -16
- data/lib/tinkerforge/bricklet_segment_display_4x7.rb +5 -5
- data/lib/tinkerforge/bricklet_solid_state_relay.rb +12 -12
- data/lib/tinkerforge/bricklet_sound_intensity.rb +13 -12
- data/lib/tinkerforge/bricklet_temperature.rb +12 -12
- data/lib/tinkerforge/bricklet_temperature_ir.rb +30 -30
- data/lib/tinkerforge/bricklet_thermocouple.rb +13 -13
- data/lib/tinkerforge/bricklet_tilt.rb +3 -3
- data/lib/tinkerforge/bricklet_uv_light.rb +10 -10
- data/lib/tinkerforge/bricklet_voltage.rb +18 -18
- data/lib/tinkerforge/bricklet_voltage_current.rb +23 -23
- data/lib/tinkerforge/version.rb +1 -1
- metadata +3 -2
@@ -1,8 +1,8 @@
|
|
1
1
|
# -*- ruby encoding: utf-8 -*-
|
2
2
|
#############################################################
|
3
|
-
# This file was automatically generated on 2017-
|
3
|
+
# This file was automatically generated on 2017-04-21. #
|
4
4
|
# #
|
5
|
-
# Ruby Bindings Version 2.1.
|
5
|
+
# Ruby Bindings Version 2.1.12 #
|
6
6
|
# #
|
7
7
|
# If you have a bugfix for this file and want to commit it, #
|
8
8
|
# please fix the bug in the generator. You can find a link #
|
@@ -36,7 +36,7 @@ module Tinkerforge
|
|
36
36
|
# voltage and the current consumption of the stepper motor.
|
37
37
|
CALLBACK_ALL_DATA = 40
|
38
38
|
|
39
|
-
# This callback is triggered whenever the Stepper Brick enters a new state.
|
39
|
+
# This callback is triggered whenever the Stepper Brick enters a new state.
|
40
40
|
# It returns the new state as well as the previous state.
|
41
41
|
CALLBACK_NEW_STATE = 41
|
42
42
|
|
@@ -77,6 +77,7 @@ module Tinkerforge
|
|
77
77
|
FUNCTION_GET_ALL_DATA = 37 # :nodoc:
|
78
78
|
FUNCTION_SET_ALL_DATA_PERIOD = 38 # :nodoc:
|
79
79
|
FUNCTION_GET_ALL_DATA_PERIOD = 39 # :nodoc:
|
80
|
+
FUNCTION_GET_SEND_TIMEOUT_COUNT = 233 # :nodoc:
|
80
81
|
FUNCTION_ENABLE_STATUS_LED = 238 # :nodoc:
|
81
82
|
FUNCTION_DISABLE_STATUS_LED = 239 # :nodoc:
|
82
83
|
FUNCTION_IS_STATUS_LED_ENABLED = 240 # :nodoc:
|
@@ -95,6 +96,14 @@ module Tinkerforge
|
|
95
96
|
STATE_DEACCELERATION = 4 # :nodoc:
|
96
97
|
STATE_DIRECTION_CHANGE_TO_FORWARD = 5 # :nodoc:
|
97
98
|
STATE_DIRECTION_CHANGE_TO_BACKWARD = 6 # :nodoc:
|
99
|
+
COMMUNICATION_METHOD_NONE = 0 # :nodoc:
|
100
|
+
COMMUNICATION_METHOD_USB = 1 # :nodoc:
|
101
|
+
COMMUNICATION_METHOD_SPI_STACK = 2 # :nodoc:
|
102
|
+
COMMUNICATION_METHOD_CHIBI = 3 # :nodoc:
|
103
|
+
COMMUNICATION_METHOD_RS485 = 4 # :nodoc:
|
104
|
+
COMMUNICATION_METHOD_WIFI = 5 # :nodoc:
|
105
|
+
COMMUNICATION_METHOD_ETHERNET = 6 # :nodoc:
|
106
|
+
COMMUNICATION_METHOD_WIFI_V2 = 7 # :nodoc:
|
98
107
|
|
99
108
|
# Creates an object with the unique device ID <tt>uid</tt> and adds it to
|
100
109
|
# the IP Connection <tt>ipcon</tt>.
|
@@ -144,6 +153,7 @@ module Tinkerforge
|
|
144
153
|
@response_expected[FUNCTION_GET_ALL_DATA_PERIOD] = RESPONSE_EXPECTED_ALWAYS_TRUE
|
145
154
|
@response_expected[CALLBACK_ALL_DATA] = RESPONSE_EXPECTED_ALWAYS_FALSE
|
146
155
|
@response_expected[CALLBACK_NEW_STATE] = RESPONSE_EXPECTED_ALWAYS_FALSE
|
156
|
+
@response_expected[FUNCTION_GET_SEND_TIMEOUT_COUNT] = RESPONSE_EXPECTED_ALWAYS_TRUE
|
147
157
|
@response_expected[FUNCTION_ENABLE_STATUS_LED] = RESPONSE_EXPECTED_FALSE
|
148
158
|
@response_expected[FUNCTION_DISABLE_STATUS_LED] = RESPONSE_EXPECTED_FALSE
|
149
159
|
@response_expected[FUNCTION_IS_STATUS_LED_ENABLED] = RESPONSE_EXPECTED_ALWAYS_TRUE
|
@@ -193,14 +203,14 @@ module Tinkerforge
|
|
193
203
|
send_request(FUNCTION_SET_SPEED_RAMPING, [acceleration, deacceleration], 'S S', 0, '')
|
194
204
|
end
|
195
205
|
|
196
|
-
# Returns the acceleration and deacceleration as set by
|
206
|
+
# Returns the acceleration and deacceleration as set by
|
197
207
|
# BrickStepper#set_speed_ramping.
|
198
208
|
def get_speed_ramping
|
199
209
|
send_request(FUNCTION_GET_SPEED_RAMPING, [], '', 4, 'S S')
|
200
210
|
end
|
201
211
|
|
202
|
-
# Executes an active full brake.
|
203
|
-
#
|
212
|
+
# Executes an active full brake.
|
213
|
+
#
|
204
214
|
# .. warning::
|
205
215
|
# This function is for emergency purposes,
|
206
216
|
# where an immediate brake is necessary. Depending on the current velocity and
|
@@ -234,7 +244,7 @@ module Tinkerforge
|
|
234
244
|
# BrickStepper#set_max_velocity and BrickStepper#set_speed_ramping.
|
235
245
|
#
|
236
246
|
# A call of BrickStepper#set_target_position with the parameter *x* is equivalent to
|
237
|
-
# a call of BrickStepper#set_steps with the parameter
|
247
|
+
# a call of BrickStepper#set_steps with the parameter
|
238
248
|
# (*x* - BrickStepper#get_current_position).
|
239
249
|
def set_target_position(position)
|
240
250
|
send_request(FUNCTION_SET_TARGET_POSITION, [position], 'l', 0, '')
|
@@ -246,7 +256,7 @@ module Tinkerforge
|
|
246
256
|
end
|
247
257
|
|
248
258
|
# Sets the number of steps the stepper motor should run. Positive values
|
249
|
-
# will drive the motor forward and negative values backward.
|
259
|
+
# will drive the motor forward and negative values backward.
|
250
260
|
# The velocity, acceleration and deacceleration as set by
|
251
261
|
# BrickStepper#set_max_velocity and BrickStepper#set_speed_ramping will be used.
|
252
262
|
def set_steps(steps)
|
@@ -259,7 +269,7 @@ module Tinkerforge
|
|
259
269
|
end
|
260
270
|
|
261
271
|
# Returns the remaining steps of the last call of BrickStepper#set_steps.
|
262
|
-
# For example, if BrickStepper#set_steps is called with 2000 and
|
272
|
+
# For example, if BrickStepper#set_steps is called with 2000 and
|
263
273
|
# BrickStepper#get_remaining_steps is called after the motor has run for 500 steps,
|
264
274
|
# it will return 1500.
|
265
275
|
def get_remaining_steps
|
@@ -287,7 +297,7 @@ module Tinkerforge
|
|
287
297
|
end
|
288
298
|
|
289
299
|
# Drives the stepper motor forward until BrickStepper#drive_backward or
|
290
|
-
# BrickStepper#stop is called. The velocity, acceleration and deacceleration as
|
300
|
+
# BrickStepper#stop is called. The velocity, acceleration and deacceleration as
|
291
301
|
# set by BrickStepper#set_max_velocity and BrickStepper#set_speed_ramping will be used.
|
292
302
|
def drive_forward
|
293
303
|
send_request(FUNCTION_DRIVE_FORWARD, [], '', 0, '')
|
@@ -300,24 +310,24 @@ module Tinkerforge
|
|
300
310
|
send_request(FUNCTION_DRIVE_BACKWARD, [], '', 0, '')
|
301
311
|
end
|
302
312
|
|
303
|
-
# Stops the stepper motor with the deacceleration as set by
|
313
|
+
# Stops the stepper motor with the deacceleration as set by
|
304
314
|
# BrickStepper#set_speed_ramping.
|
305
315
|
def stop
|
306
316
|
send_request(FUNCTION_STOP, [], '', 0, '')
|
307
317
|
end
|
308
318
|
|
309
319
|
# Returns the stack input voltage in mV. The stack input voltage is the
|
310
|
-
# voltage that is supplied via the stack, i.e. it is given by a
|
320
|
+
# voltage that is supplied via the stack, i.e. it is given by a
|
311
321
|
# Step-Down or Step-Up Power Supply.
|
312
322
|
def get_stack_input_voltage
|
313
323
|
send_request(FUNCTION_GET_STACK_INPUT_VOLTAGE, [], '', 2, 'S')
|
314
324
|
end
|
315
325
|
|
316
326
|
# Returns the external input voltage in mV. The external input voltage is
|
317
|
-
# given via the black power input connector on the Stepper Brick.
|
318
|
-
#
|
327
|
+
# given via the black power input connector on the Stepper Brick.
|
328
|
+
#
|
319
329
|
# If there is an external input voltage and a stack input voltage, the motor
|
320
|
-
# will be driven by the external input voltage. If there is only a stack
|
330
|
+
# will be driven by the external input voltage. If there is only a stack
|
321
331
|
# voltage present, the motor will be driven by this voltage.
|
322
332
|
#
|
323
333
|
# .. warning::
|
@@ -335,7 +345,7 @@ module Tinkerforge
|
|
335
345
|
end
|
336
346
|
|
337
347
|
# Sets the current in mA with which the motor will be driven.
|
338
|
-
# The minimum value is 100mA, the maximum value 2291mA and the
|
348
|
+
# The minimum value is 100mA, the maximum value 2291mA and the
|
339
349
|
# default value is 800mA.
|
340
350
|
#
|
341
351
|
# .. warning::
|
@@ -375,13 +385,13 @@ module Tinkerforge
|
|
375
385
|
# Changing the decay mode is only possible if synchronous rectification
|
376
386
|
# is enabled (see BrickStepper#set_sync_rect).
|
377
387
|
#
|
378
|
-
# For a good explanation of the different decay modes see
|
388
|
+
# For a good explanation of the different decay modes see
|
379
389
|
# `this <http://ebldc.com/?p=86/>`__ blog post by Avayan.
|
380
390
|
#
|
381
391
|
# A good decay mode is unfortunately different for every motor. The best
|
382
392
|
# way to work out a good decay mode for your stepper motor, if you can't
|
383
393
|
# measure the current with an oscilloscope, is to listen to the sound of
|
384
|
-
# the motor. If the value is too low, you often hear a high pitched
|
394
|
+
# the motor. If the value is too low, you often hear a high pitched
|
385
395
|
# sound and if it is too high you can often hear a humming sound.
|
386
396
|
#
|
387
397
|
# Generally, fast decay mode (small value) will be noisier but also
|
@@ -406,7 +416,7 @@ module Tinkerforge
|
|
406
416
|
# Sets the minimum voltage in mV, below which the CALLBACK_UNDER_VOLTAGE callback
|
407
417
|
# is triggered. The minimum possible value that works with the Stepper Brick is 8V.
|
408
418
|
# You can use this function to detect the discharge of a battery that is used
|
409
|
-
# to drive the stepper motor. If you have a fixed power supply, you likely do
|
419
|
+
# to drive the stepper motor. If you have a fixed power supply, you likely do
|
410
420
|
# not need this functionality.
|
411
421
|
#
|
412
422
|
# The default value is 8V.
|
@@ -425,11 +435,11 @@ module Tinkerforge
|
|
425
435
|
# (see BrickStepper#set_decay). Without synchronous rectification fast
|
426
436
|
# decay is used.
|
427
437
|
#
|
428
|
-
# For an explanation of synchronous rectification see
|
438
|
+
# For an explanation of synchronous rectification see
|
429
439
|
# `here <https://en.wikipedia.org/wiki/Active_rectification>`__.
|
430
440
|
#
|
431
441
|
# .. warning::
|
432
|
-
# If you want to use high speeds (> 10000 steps/s) for a large
|
442
|
+
# If you want to use high speeds (> 10000 steps/s) for a large
|
433
443
|
# stepper motor with a large inductivity we strongly
|
434
444
|
# suggest that you disable synchronous rectification. Otherwise the
|
435
445
|
# Brick may not be able to cope with the load and overheat.
|
@@ -447,8 +457,8 @@ module Tinkerforge
|
|
447
457
|
# Sets the time base of the velocity and the acceleration of the stepper brick
|
448
458
|
# (in seconds).
|
449
459
|
#
|
450
|
-
# For example, if you want to make one step every 1.5 seconds, you can set
|
451
|
-
# the time base to 15 and the velocity to 10. Now the velocity is
|
460
|
+
# For example, if you want to make one step every 1.5 seconds, you can set
|
461
|
+
# the time base to 15 and the velocity to 10. Now the velocity is
|
452
462
|
# 10steps/15s = 1steps/1.5s.
|
453
463
|
#
|
454
464
|
# The default value is 1.
|
@@ -465,7 +475,7 @@ module Tinkerforge
|
|
465
475
|
# the current position, the remaining steps, the stack voltage, the external
|
466
476
|
# voltage and the current consumption of the stepper motor.
|
467
477
|
#
|
468
|
-
# There is also a callback for this function, see CALLBACK_ALL_DATA.
|
478
|
+
# There is also a callback for this function, see CALLBACK_ALL_DATA callback.
|
469
479
|
def get_all_data
|
470
480
|
send_request(FUNCTION_GET_ALL_DATA, [], '', 16, 'S l l S S S')
|
471
481
|
end
|
@@ -481,6 +491,18 @@ module Tinkerforge
|
|
481
491
|
send_request(FUNCTION_GET_ALL_DATA_PERIOD, [], '', 4, 'L')
|
482
492
|
end
|
483
493
|
|
494
|
+
# Returns the timeout count for the different communication methods.
|
495
|
+
#
|
496
|
+
# The methods 0-2 are available for all Bricks, 3-7 only for Master Bricks.
|
497
|
+
#
|
498
|
+
# This function is mostly used for debugging during development, in normal operation
|
499
|
+
# the counters should nearly always stay at 0.
|
500
|
+
#
|
501
|
+
# .. versionadded:: 2.3.4$nbsp;(Firmware)
|
502
|
+
def get_send_timeout_count(communication_method)
|
503
|
+
send_request(FUNCTION_GET_SEND_TIMEOUT_COUNT, [communication_method], 'C', 4, 'L')
|
504
|
+
end
|
505
|
+
|
484
506
|
# Enables the status LED.
|
485
507
|
#
|
486
508
|
# The status LED is the blue LED next to the USB connector. If enabled is is
|
@@ -541,7 +563,7 @@ module Tinkerforge
|
|
541
563
|
send_request(FUNCTION_RESET, [], '', 0, '')
|
542
564
|
end
|
543
565
|
|
544
|
-
# Returns the UID, the UID where the Brick is connected to,
|
566
|
+
# Returns the UID, the UID where the Brick is connected to,
|
545
567
|
# the position, the hardware and firmware version as well as the
|
546
568
|
# device identifier.
|
547
569
|
#
|
@@ -1,8 +1,8 @@
|
|
1
1
|
# -*- ruby encoding: utf-8 -*-
|
2
2
|
#############################################################
|
3
|
-
# This file was automatically generated on 2017-
|
3
|
+
# This file was automatically generated on 2017-04-21. #
|
4
4
|
# #
|
5
|
-
# Ruby Bindings Version 2.1.
|
5
|
+
# Ruby Bindings Version 2.1.12 #
|
6
6
|
# #
|
7
7
|
# If you have a bugfix for this file and want to commit it, #
|
8
8
|
# please fix the bug in the generator. You can find a link #
|
@@ -19,8 +19,8 @@ module Tinkerforge
|
|
19
19
|
# BrickletAccelerometer#set_acceleration_callback_period. The parameters are the
|
20
20
|
# X, Y and Z acceleration.
|
21
21
|
#
|
22
|
-
# CALLBACK_ACCELERATION is only triggered if the acceleration has
|
23
|
-
# last triggering.
|
22
|
+
# The CALLBACK_ACCELERATION callback is only triggered if the acceleration has
|
23
|
+
# changed since the last triggering.
|
24
24
|
CALLBACK_ACCELERATION = 14
|
25
25
|
|
26
26
|
# This callback is triggered when the threshold as set by
|
@@ -102,8 +102,8 @@ module Tinkerforge
|
|
102
102
|
# Returns the acceleration in x, y and z direction. The values
|
103
103
|
# are given in g/1000 (1g = 9.80665m/s²), not to be confused with grams.
|
104
104
|
#
|
105
|
-
# If you want to get the acceleration periodically, it is recommended
|
106
|
-
# to use the callback
|
105
|
+
# If you want to get the acceleration periodically, it is recommended
|
106
|
+
# to use the CALLBACK_ACCELERATION callback and set the period with
|
107
107
|
# BrickletAccelerometer#set_acceleration_callback_period.
|
108
108
|
def get_acceleration
|
109
109
|
send_request(FUNCTION_GET_ACCELERATION, [], '', 6, 's s s')
|
@@ -112,8 +112,8 @@ module Tinkerforge
|
|
112
112
|
# Sets the period in ms with which the CALLBACK_ACCELERATION callback is triggered
|
113
113
|
# periodically. A value of 0 turns the callback off.
|
114
114
|
#
|
115
|
-
# CALLBACK_ACCELERATION is only triggered if the acceleration has
|
116
|
-
# last triggering.
|
115
|
+
# The CALLBACK_ACCELERATION callback is only triggered if the acceleration has
|
116
|
+
# changed since the last triggering.
|
117
117
|
#
|
118
118
|
# The default value is 0.
|
119
119
|
def set_acceleration_callback_period(period)
|
@@ -125,7 +125,7 @@ module Tinkerforge
|
|
125
125
|
send_request(FUNCTION_GET_ACCELERATION_CALLBACK_PERIOD, [], '', 4, 'L')
|
126
126
|
end
|
127
127
|
|
128
|
-
# Sets the thresholds for the CALLBACK_ACCELERATION_REACHED callback.
|
128
|
+
# Sets the thresholds for the CALLBACK_ACCELERATION_REACHED callback.
|
129
129
|
#
|
130
130
|
# The following options are possible:
|
131
131
|
#
|
@@ -179,7 +179,7 @@ module Tinkerforge
|
|
179
179
|
# * Full scale range of -2G to +2G up to -16G to +16G.
|
180
180
|
# * Filter bandwidth between 50Hz and 800Hz.
|
181
181
|
#
|
182
|
-
# Decreasing data rate or full scale range will also decrease the noise on
|
182
|
+
# Decreasing data rate or full scale range will also decrease the noise on
|
183
183
|
# the data.
|
184
184
|
#
|
185
185
|
# The default values are 100Hz data rate, -4G to +4G range and 200Hz
|
@@ -208,7 +208,7 @@ module Tinkerforge
|
|
208
208
|
send_request(FUNCTION_IS_LED_ON, [], '', 1, '?')
|
209
209
|
end
|
210
210
|
|
211
|
-
# Returns the UID, the UID where the Bricklet is connected to,
|
211
|
+
# Returns the UID, the UID where the Bricklet is connected to,
|
212
212
|
# the position, the hardware and firmware version as well as the
|
213
213
|
# device identifier.
|
214
214
|
#
|
@@ -1,8 +1,8 @@
|
|
1
1
|
# -*- ruby encoding: utf-8 -*-
|
2
2
|
#############################################################
|
3
|
-
# This file was automatically generated on 2017-
|
3
|
+
# This file was automatically generated on 2017-04-21. #
|
4
4
|
# #
|
5
|
-
# Ruby Bindings Version 2.1.
|
5
|
+
# Ruby Bindings Version 2.1.12 #
|
6
6
|
# #
|
7
7
|
# If you have a bugfix for this file and want to commit it, #
|
8
8
|
# please fix the bug in the generator. You can find a link #
|
@@ -19,7 +19,7 @@ module Tinkerforge
|
|
19
19
|
# BrickletAmbientLight#set_illuminance_callback_period. The parameter is the illuminance of the
|
20
20
|
# ambient light sensor.
|
21
21
|
#
|
22
|
-
# CALLBACK_ILLUMINANCE is only triggered if the illuminance has changed since the
|
22
|
+
# The CALLBACK_ILLUMINANCE callback is only triggered if the illuminance has changed since the
|
23
23
|
# last triggering.
|
24
24
|
CALLBACK_ILLUMINANCE = 13
|
25
25
|
|
@@ -27,7 +27,7 @@ module Tinkerforge
|
|
27
27
|
# BrickletAmbientLight#set_analog_value_callback_period. The parameter is the analog value of the
|
28
28
|
# ambient light sensor.
|
29
29
|
#
|
30
|
-
# CALLBACK_ANALOG_VALUE is only triggered if the analog value has changed since the
|
30
|
+
# The CALLBACK_ANALOG_VALUE callback is only triggered if the analog value has changed since the
|
31
31
|
# last triggering.
|
32
32
|
CALLBACK_ANALOG_VALUE = 14
|
33
33
|
|
@@ -103,7 +103,7 @@ module Tinkerforge
|
|
103
103
|
# of 4500 means that an illuminance of 450lux is measured.
|
104
104
|
#
|
105
105
|
# If you want to get the illuminance periodically, it is recommended to use the
|
106
|
-
# callback
|
106
|
+
# CALLBACK_ILLUMINANCE callback and set the period with
|
107
107
|
# BrickletAmbientLight#set_illuminance_callback_period.
|
108
108
|
def get_illuminance
|
109
109
|
send_request(FUNCTION_GET_ILLUMINANCE, [], '', 2, 'S')
|
@@ -122,8 +122,8 @@ module Tinkerforge
|
|
122
122
|
# set dynamically depending on the light intensity. It is impossible to
|
123
123
|
# distinguish between these ranges with the analog value.
|
124
124
|
#
|
125
|
-
# If you want the analog value periodically, it is recommended to use the
|
126
|
-
# callback
|
125
|
+
# If you want the analog value periodically, it is recommended to use the
|
126
|
+
# CALLBACK_ANALOG_VALUE callback and set the period with
|
127
127
|
# BrickletAmbientLight#set_analog_value_callback_period.
|
128
128
|
def get_analog_value
|
129
129
|
send_request(FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S')
|
@@ -132,7 +132,7 @@ module Tinkerforge
|
|
132
132
|
# Sets the period in ms with which the CALLBACK_ILLUMINANCE callback is triggered
|
133
133
|
# periodically. A value of 0 turns the callback off.
|
134
134
|
#
|
135
|
-
# CALLBACK_ILLUMINANCE is only triggered if the illuminance has changed since the
|
135
|
+
# The CALLBACK_ILLUMINANCE callback is only triggered if the illuminance has changed since the
|
136
136
|
# last triggering.
|
137
137
|
#
|
138
138
|
# The default value is 0.
|
@@ -148,7 +148,7 @@ module Tinkerforge
|
|
148
148
|
# Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered
|
149
149
|
# periodically. A value of 0 turns the callback off.
|
150
150
|
#
|
151
|
-
# CALLBACK_ANALOG_VALUE is only triggered if the analog value has changed since the
|
151
|
+
# The CALLBACK_ANALOG_VALUE callback is only triggered if the analog value has changed since the
|
152
152
|
# last triggering.
|
153
153
|
#
|
154
154
|
# The default value is 0.
|
@@ -161,7 +161,7 @@ module Tinkerforge
|
|
161
161
|
send_request(FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD, [], '', 4, 'L')
|
162
162
|
end
|
163
163
|
|
164
|
-
# Sets the thresholds for the CALLBACK_ILLUMINANCE_REACHED callback.
|
164
|
+
# Sets the thresholds for the CALLBACK_ILLUMINANCE_REACHED callback.
|
165
165
|
#
|
166
166
|
# The following options are possible:
|
167
167
|
#
|
@@ -183,7 +183,7 @@ module Tinkerforge
|
|
183
183
|
send_request(FUNCTION_GET_ILLUMINANCE_CALLBACK_THRESHOLD, [], '', 5, 'k S S')
|
184
184
|
end
|
185
185
|
|
186
|
-
# Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.
|
186
|
+
# Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.
|
187
187
|
#
|
188
188
|
# The following options are possible:
|
189
189
|
#
|
@@ -227,7 +227,7 @@ module Tinkerforge
|
|
227
227
|
send_request(FUNCTION_GET_DEBOUNCE_PERIOD, [], '', 4, 'L')
|
228
228
|
end
|
229
229
|
|
230
|
-
# Returns the UID, the UID where the Bricklet is connected to,
|
230
|
+
# Returns the UID, the UID where the Bricklet is connected to,
|
231
231
|
# the position, the hardware and firmware version as well as the
|
232
232
|
# device identifier.
|
233
233
|
#
|
@@ -1,8 +1,8 @@
|
|
1
1
|
# -*- ruby encoding: utf-8 -*-
|
2
2
|
#############################################################
|
3
|
-
# This file was automatically generated on 2017-
|
3
|
+
# This file was automatically generated on 2017-04-21. #
|
4
4
|
# #
|
5
|
-
# Ruby Bindings Version 2.1.
|
5
|
+
# Ruby Bindings Version 2.1.12 #
|
6
6
|
# #
|
7
7
|
# If you have a bugfix for this file and want to commit it, #
|
8
8
|
# please fix the bug in the generator. You can find a link #
|
@@ -19,7 +19,7 @@ module Tinkerforge
|
|
19
19
|
# BrickletAmbientLightV2#set_illuminance_callback_period. The parameter is the illuminance of the
|
20
20
|
# ambient light sensor.
|
21
21
|
#
|
22
|
-
# CALLBACK_ILLUMINANCE is only triggered if the illuminance has changed since the
|
22
|
+
# The CALLBACK_ILLUMINANCE callback is only triggered if the illuminance has changed since the
|
23
23
|
# last triggering.
|
24
24
|
CALLBACK_ILLUMINANCE = 10
|
25
25
|
|
@@ -97,7 +97,7 @@ module Tinkerforge
|
|
97
97
|
# configuration should be modified, see BrickletAmbientLightV2#set_configuration.
|
98
98
|
#
|
99
99
|
# If you want to get the illuminance periodically, it is recommended to use the
|
100
|
-
# callback
|
100
|
+
# CALLBACK_ILLUMINANCE callback and set the period with
|
101
101
|
# BrickletAmbientLightV2#set_illuminance_callback_period.
|
102
102
|
def get_illuminance
|
103
103
|
send_request(FUNCTION_GET_ILLUMINANCE, [], '', 4, 'L')
|
@@ -106,8 +106,8 @@ module Tinkerforge
|
|
106
106
|
# Sets the period in ms with which the CALLBACK_ILLUMINANCE callback is triggered
|
107
107
|
# periodically. A value of 0 turns the callback off.
|
108
108
|
#
|
109
|
-
# CALLBACK_ILLUMINANCE is only triggered if the illuminance has changed
|
110
|
-
# last triggering.
|
109
|
+
# The CALLBACK_ILLUMINANCE callback is only triggered if the illuminance has changed
|
110
|
+
# since the last triggering.
|
111
111
|
#
|
112
112
|
# The default value is 0.
|
113
113
|
def set_illuminance_callback_period(period)
|
@@ -119,7 +119,7 @@ module Tinkerforge
|
|
119
119
|
send_request(FUNCTION_GET_ILLUMINANCE_CALLBACK_PERIOD, [], '', 4, 'L')
|
120
120
|
end
|
121
121
|
|
122
|
-
# Sets the thresholds for the CALLBACK_ILLUMINANCE_REACHED callback.
|
122
|
+
# Sets the thresholds for the CALLBACK_ILLUMINANCE_REACHED callback.
|
123
123
|
#
|
124
124
|
# The following options are possible:
|
125
125
|
#
|
@@ -195,7 +195,7 @@ module Tinkerforge
|
|
195
195
|
send_request(FUNCTION_GET_CONFIGURATION, [], '', 2, 'C C')
|
196
196
|
end
|
197
197
|
|
198
|
-
# Returns the UID, the UID where the Bricklet is connected to,
|
198
|
+
# Returns the UID, the UID where the Bricklet is connected to,
|
199
199
|
# the position, the hardware and firmware version as well as the
|
200
200
|
# device identifier.
|
201
201
|
#
|
@@ -1,8 +1,8 @@
|
|
1
1
|
# -*- ruby encoding: utf-8 -*-
|
2
2
|
#############################################################
|
3
|
-
# This file was automatically generated on 2017-
|
3
|
+
# This file was automatically generated on 2017-04-21. #
|
4
4
|
# #
|
5
|
-
# Ruby Bindings Version 2.1.
|
5
|
+
# Ruby Bindings Version 2.1.12 #
|
6
6
|
# #
|
7
7
|
# If you have a bugfix for this file and want to commit it, #
|
8
8
|
# please fix the bug in the generator. You can find a link #
|
@@ -19,16 +19,16 @@ module Tinkerforge
|
|
19
19
|
# BrickletAnalogIn#set_voltage_callback_period. The parameter is the voltage of the
|
20
20
|
# sensor.
|
21
21
|
#
|
22
|
-
# CALLBACK_VOLTAGE is only triggered if the voltage has changed since
|
23
|
-
# last triggering.
|
22
|
+
# The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since
|
23
|
+
# the last triggering.
|
24
24
|
CALLBACK_VOLTAGE = 13
|
25
25
|
|
26
26
|
# This callback is triggered periodically with the period that is set by
|
27
|
-
# BrickletAnalogIn#set_analog_value_callback_period. The parameter is the analog
|
28
|
-
# sensor.
|
27
|
+
# BrickletAnalogIn#set_analog_value_callback_period. The parameter is the analog
|
28
|
+
# value of the sensor.
|
29
29
|
#
|
30
|
-
# CALLBACK_ANALOG_VALUE is only triggered if the voltage has changed
|
31
|
-
# last triggering.
|
30
|
+
# The CALLBACK_ANALOG_VALUE callback is only triggered if the voltage has changed
|
31
|
+
# since the last triggering.
|
32
32
|
CALLBACK_ANALOG_VALUE = 14
|
33
33
|
|
34
34
|
# This callback is triggered when the threshold as set by
|
@@ -117,7 +117,7 @@ module Tinkerforge
|
|
117
117
|
# Between 6 and 45V the resolution is about 10mV.
|
118
118
|
#
|
119
119
|
# If you want to get the voltage periodically, it is recommended to use the
|
120
|
-
# callback
|
120
|
+
# CALLBACK_VOLTAGE callback and set the period with
|
121
121
|
# BrickletAnalogIn#set_voltage_callback_period.
|
122
122
|
def get_voltage
|
123
123
|
send_request(FUNCTION_GET_VOLTAGE, [], '', 2, 'S')
|
@@ -132,8 +132,8 @@ module Tinkerforge
|
|
132
132
|
# unfiltered analog values. The only reason to use BrickletAnalogIn#get_analog_value is,
|
133
133
|
# if you need the full resolution of the analog-to-digital converter.
|
134
134
|
#
|
135
|
-
# If you want the analog value periodically, it is recommended to use the
|
136
|
-
# callback
|
135
|
+
# If you want the analog value periodically, it is recommended to use the
|
136
|
+
# CALLBACK_ANALOG_VALUE callback and set the period with
|
137
137
|
# BrickletAnalogIn#set_analog_value_callback_period.
|
138
138
|
def get_analog_value
|
139
139
|
send_request(FUNCTION_GET_ANALOG_VALUE, [], '', 2, 'S')
|
@@ -142,8 +142,8 @@ module Tinkerforge
|
|
142
142
|
# Sets the period in ms with which the CALLBACK_VOLTAGE callback is triggered
|
143
143
|
# periodically. A value of 0 turns the callback off.
|
144
144
|
#
|
145
|
-
# CALLBACK_VOLTAGE is only triggered if the voltage has changed since
|
146
|
-
# last triggering.
|
145
|
+
# The CALLBACK_VOLTAGE callback is only triggered if the voltage has changed since
|
146
|
+
# the last triggering.
|
147
147
|
#
|
148
148
|
# The default value is 0.
|
149
149
|
def set_voltage_callback_period(period)
|
@@ -158,8 +158,8 @@ module Tinkerforge
|
|
158
158
|
# Sets the period in ms with which the CALLBACK_ANALOG_VALUE callback is triggered
|
159
159
|
# periodically. A value of 0 turns the callback off.
|
160
160
|
#
|
161
|
-
# CALLBACK_ANALOG_VALUE is only triggered if the analog value has
|
162
|
-
# last triggering.
|
161
|
+
# The CALLBACK_ANALOG_VALUE callback is only triggered if the analog value has
|
162
|
+
# changed since the last triggering.
|
163
163
|
#
|
164
164
|
# The default value is 0.
|
165
165
|
def set_analog_value_callback_period(period)
|
@@ -171,7 +171,7 @@ module Tinkerforge
|
|
171
171
|
send_request(FUNCTION_GET_ANALOG_VALUE_CALLBACK_PERIOD, [], '', 4, 'L')
|
172
172
|
end
|
173
173
|
|
174
|
-
# Sets the thresholds for the CALLBACK_VOLTAGE_REACHED callback.
|
174
|
+
# Sets the thresholds for the CALLBACK_VOLTAGE_REACHED callback.
|
175
175
|
#
|
176
176
|
# The following options are possible:
|
177
177
|
#
|
@@ -193,7 +193,7 @@ module Tinkerforge
|
|
193
193
|
send_request(FUNCTION_GET_VOLTAGE_CALLBACK_THRESHOLD, [], '', 5, 'k S S')
|
194
194
|
end
|
195
195
|
|
196
|
-
# Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.
|
196
|
+
# Sets the thresholds for the CALLBACK_ANALOG_VALUE_REACHED callback.
|
197
197
|
#
|
198
198
|
# The following options are possible:
|
199
199
|
#
|
@@ -280,7 +280,7 @@ module Tinkerforge
|
|
280
280
|
send_request(FUNCTION_GET_AVERAGING, [], '', 1, 'C')
|
281
281
|
end
|
282
282
|
|
283
|
-
# Returns the UID, the UID where the Bricklet is connected to,
|
283
|
+
# Returns the UID, the UID where the Bricklet is connected to,
|
284
284
|
# the position, the hardware and firmware version as well as the
|
285
285
|
# device identifier.
|
286
286
|
#
|